doc-writing

Name: doc-writing
Author: huangjia2019

1.0kstars362forks

How to install doc-writing?

huangjia2019/claude-code-engineering/doc-writing

$npx -y skills add huangjia2019/claude-code-engineering --skill doc-writing

Installs into the current project.

Summary

Generate API documentation from a route manifest. Use when you have a list of discovered routes and need to produce markdown documentation.

Files · 1

View on GitHub

SKILL.md

1	# Doc Writing Skill
2
3	Generate structured API documentation from a route manifest.
4
5	## Input
6
7	You will receive a route manifest (JSON array) from the previous pipeline stage.
8	Each entry contains: method, path, file, line, middleware, type.
9
10	## Process
11
12	### Step 1: Read Source Code
13
14	For each route in the manifest, read the source file to understand:
15	- Request parameters (path, query, body)
16	- Response format
17	- Error handling
18	- Business logic summary
19
20	### Step 2: Generate Documentation
21
22	Use the template at `templates/endpoint-doc.md` for each route group.
23
24	Group routes by their source file (e.g., all product routes together).
25
26	### Step 3: Write Files
27
28	Write one markdown file per route group to the `docs/` directory:
29	- `docs/products-api.md`
30	- `docs/categories-api.md`
31	- etc.
32
33	## Output
34
35	Return a manifest of generated documentation files:
36
37	```json
38	{
39	"files_generated": ["docs/products-api.md", "docs/categories-api.md"],
40	"routes_documented": 8,
41	"routes_skipped": [],
42	"warnings": []
43	}
44	```
45
46	This manifest will be consumed by the next pipeline stage (quality-checking).

People who liked this also viewed

6 picks

Type

grill-with-docsA relentless interview to sharpen a plan or design, which also creates docs (ADR's and glossary) as we go.SkillsJul 2026537k182k
lark-minutes飞书妙记：搜索妙记、查看妙记基础信息、下载/上传音视频、读取或编辑妙记的产物内容、改标题、替换说话人/关键词、申请妙记查看/编辑权限。当给出minute_token、本地音视频文件，要查/改/转妙记产物，或用户明确要主动申请妙记权限时使用；本地音视频转纪要/逐字稿优先走本 skill，不要用 ffmpeg/whisper 本地转写。不负责：获取会议关联妙记，或仅按自然语言标题定位纪要SkillsJul 2026379k16k
lark-markdown飞书 Markdown：查看、创建、上传、编辑和比较 Markdown 文件。当用户需要创建或编辑 Markdown 文件、读取、修改、局部 patch 或比较差异时使用。不负责将 Markdown 导入为飞书在线文档，也不负责文件搜索、权限、评论、移动、删除等云空间管理操作。SkillsJul 2026295k16k
docxUse this skill whenever the user wants to create, read, edit, or manipulate Word documents (.docx files) or Word templates (.dotx files). Triggers include: any mention of 'Word doc', 'word document', SkillsJul 2026157k163k
edit-articleSkills for Real Engineers. Straight from my .agents directory.SkillsJul 2026154k181k
lark-note飞书会议纪要（Note）直查：已知 note_id 时查询纪要详情、展示类型、关联文档 token，并读取 unified 原始逐字记录。当用户已持有 note_id，或从文档显式 vc-node-id 获得 note_id 时使用。不负责会议/日程/妙记定位、文档标题搜索或 Docx 正文读取。SkillsJul 2026154k16k