Doc Writing
Turns a scanned route manifest into grouped, templated Markdown API docs for a pipeline stage.
Test report
- Verdict
- Tested · Works
- Score
- Tested
- Jul 13, 2026
- Environment
- Claude Code 2.x (agent harness)
- Upstream re-checked
- Aug 10, 2026 · 90f7af3
Fed it a 3-route manifest across 2 source files: it correctly split output into products-api.md and categories-api.md following the bundled endpoint-doc.md template (with a real 🔒 auth marker and parameter/response tables) plus a machine-readable files_generated manifest for the next pipeline stage — a baseline pass produced one flat, ungrouped file with no manifest.
Scored on four weighted criteria — install, triggering, output vs. baseline, docs. How scoring works
- Installs cleanly 5/5
- Triggers reliably 5/5
- Output vs. baseline 8/10
- Docs & honesty 5/5
What Doc Writing does
Generates grouped Markdown API documentation from a JSON route manifest (method/path/file/line/middleware/type), filling in a fixed endpoint-doc.md template with parameter and response tables and an auth lock icon. Built as stage 2 of a 3-stage teaching pipeline (route-scanner to doc-writer to quality-checker) from a Claude Code course repo, so it triggers specifically once a route manifest already exists rather than for open-ended 'write my docs' requests.
How to install Doc Writing
git clone https://github.com/huangjia2019/claude-code-engineering
cd claude-code-engineering
mkdir -p ~/.claude/skills
cp -r 04-Skills/projects/08-skill-pipeline/.claude/skills/doc-writing ~/.claude/skills/doc-writing
Skills live in ~/.claude/skills/ (global) or .claude/skills/
(per-project). Restart Claude Code after installing.
Commands — how to trigger Doc Writing
-
/doc-writingTurns a scanned route manifest into grouped, templated Markdown API docs for a pipeline stage.
It also activates on plain-language prompts like these:
-
Generate Markdown API docs from this route manifest JSON we scanned -
Fill in the endpoint doc template with params and response tables for these routes -
Write grouped API reference docs from the scanned route list with auth icons
Frequently asked questions
- Is the Doc Writing skill free?
- Yes. The skill itself is free from huangjia2019/claude-code-engineering. SkillProof publishes the install command and an independent test verdict at no cost.
- Does Doc Writing work with Claude Code?
- We tested it with Claude Code 2.x (agent harness) on Jul 13, 2026. Verdict: Tested · Works. Fed it a 3-route manifest across 2 source files: it correctly split output into products-api.md and categories-api.md following the bundled endpoint-doc.md template (with a real 🔒 auth marker and parameter/response tables) plus a machine-readable files_generated manifest for the next pipeline stage — a baseline pass produced one flat, ungrouped file with no manifest.
- What is the Doc Writing SkillProof Score?
- 9.2/10 — installs cleanly 5/5, triggers reliably 5/5, output vs. baseline 8/10, docs & honesty 5/5.
- How do I install Doc Writing?
- Copy the install command from this page, run it in your terminal, and restart Claude Code. Skills live in ~/.claude/skills/ (global) or .claude/skills/ inside a project.
- Can I use Doc Writing with Cursor, Copilot, Gemini CLI, Codex or other AI tools?
- The SKILL.md format is native to Claude (Claude Code, Desktop, claude.ai). The instructions inside adapt to other assistants: Cursor rules, GitHub Copilot instructions, Windsurf rules, Custom GPTs, AGENTS.md for OpenAI Codex, and GEMINI.md for Google Gemini CLI — our conversion guides cover each, and the free converter on the tools page does the wrapping for you.