doc-writing
Generate API documentation from a route manifest. Use when you have a list of discovered routes and need to produce markdown documentation.
npx skills add huangjia2019/claude-code-engineering --skill doc-writing --agent claude-code
Same command for any agent — swap --agent for codex, cursor, copilot.
Weekly change comes from our own snapshots, not the repository page — it measures attention, not adoption.
# Doc Writing Skill Generate structured API documentation from a route manifest. ## Input You will receive a route manifest (JSON array) from the previous pipeline stage. Each entry contains: method, path, file, line, middleware, type. ## Process ### Step 1: Read Source Code For each route in the manifest, read the source file to understand: - Request parameters (path, query, body) - Response format - Error handling - Business logic summary ### Step 2: Generate Documentation Use the template at `templates/endpoint-doc.md` for each route group. Group routes by their source file (e.g., all product routes together). ### Step 3: Write Files Write one markdown file per route group to the `docs/` directory: - `docs/products-api.md` - `docs/categories-api.md` - etc. ## Output Return a manifest of generated documentation files: ```json { "files_generated": ["docs/products-api.md", "docs/categories-api.md"], "routes_documented": 8, "routes_skipped": [], "warnings": [] } ``` This manifest will be consumed by the next pipeline stage (quality-checking).
- Input
- Process
- Step 1: Read Source Code
- Step 2: Generate Documentation
- Step 3: Write Files
- Output
What does the doc-writing skill do?
Generate API documentation from a route manifest. Use when you have a list of discovered routes and need to produce markdown documentation.
How do I install it?
Run `npx skills add huangjia2019/claude-code-engineering --skill doc-writing --agent claude-code` — it drops the skill into your project so the agent can pick it up. Swap the --agent value for codex, cursor or copilot if you use one of those.
Where does this skill come from?
From huangjia2019/claude-code-engineering, a repository with 1,040 stars. We read it straight from the repository tree rather than a submitted listing, so what you see here is what is actually published.
Is a popular skill a good skill?
Not necessarily. Stars measure attention, not adoption — a repository can trend for a week and be abandoned. That is why we show the weekly change from our own snapshots next to the total, instead of a single flattering number.