TopRank Skills

Home / Claw Skills / Intégration d'API / Docs Generator
Official OpenClaw rules 54%

Docs Generator

Automated documentation generator. API docs, README, CHANGELOG, contributing guide, architecture docs, tutorials, FAQ, reference manual. REST, GraphQL, OpenAPI. documentation, technical-writing, api-docs, developer-tools.

Stars

0

Installs

0

Status

ACTIVE

Visibility

PUBLIC

安装方式

直接复制以下提示词,发送给你的 AI 助手即可完成安装。

请先检查是否已安装 SkillHub 商店,若未安装,请根据 https://skillhub-1388575217.cos.ap-guangzhou.myqcloud.com/install/skillhub.md 安装 SkillHub 商店,然后安装 Docs Generator 技能。 若已安装,则直接安装 Docs Generator 技能。

Overview

Skill Key
ckchzh/docs-generator
Author
ckchzh
Source Repo
openclaw/skills
Version
-
Source Path
skills/ckchzh/docs-generator
Latest Commit SHA
8eb6d1f50a060998fbee21f8679b97dfc6741098

Extracted Content

SKILL.md excerpt

# Docs Generator — Automated Documentation

Spend less time writing docs, more time writing code.

## Command Map

```
┌─ api ──────── REST/GraphQL API documentation
├─ readme ───── Project README.md
├─ changelog ── Version change log
├─ contributing Contributing guide
├─ architecture System architecture docs
├─ tutorial ─── Tutorial / quick start guide
├─ faq ──────── Frequently asked questions
└─ reference ── Complete reference manual
```

## Usage

```bash
bash scripts/docs-generator.sh api rest users
bash scripts/docs-generator.sh readme myproject "A cool tool"
bash scripts/docs-generator.sh changelog 2.0.0 "New features"
```

## Arguments

- `api <type> <resource>` — type: rest/graphql, resource name
- `readme <name> <desc>` — project name and description
- `changelog <ver> <summary>` — version and summary
- `contributing <project>` — project name
- `architecture <project> <style>` — style: monolith/microservice/serverless
- `tutorial <topic> <level>` — level: beginner/intermediate/advanced
- `faq <topic> <count>` — generate N FAQ entries
- `reference <lib> <lang>` — library name and language

## Philosophy

Documentation is a product. Good docs = more users = fewer issues.

Related Claw Skills