Documentation generation
Skill ligyDt/ai-ide-init-template/cursor/.cursor/skills/documentation-generation
生成或更新 README、API 文档、架构说明、使用指南、变更说明、运行手册和交接文档。From its SKILL.md
npx -y skills add ligyDt/ai-ide-init-template --skill documentation-generationAssembled from the repository path, not quoted from the project. Check it against their README if it does not work.
One thing to look at
- 3 stars3 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.
SKILL.md
0.9 KB, 295 tokens by cl100k_base, as published. Nobody here has run it
文档自动生成
流程
- 明确文档读者、使用场景、维护位置和更新触发条件。
- 读取现有 README、接口定义、配置文件、脚本和架构决策，避免凭空编写。
- 区分用户指南、开发者指南、运维手册、API 文档和决策记录。
- 对外部账号、支付、生产数据、发布和部署内容只写安全边界与审批步骤，不写真实凭据。
- 输出结构清晰、可验证、可维护的中文文档。
输出
- 文档目标与读者
- 推荐目录结构
- 可直接落地的正文
- 验证命令与维护说明
停止条件
缺少目标、范围、运行环境或高风险授权时，先澄清或输出待确认事项，不擅自接入外部写入、支付、部署或生产资源。
What ships with it
Read from the repository
Just SKILL.md. No reference files, no scripts.
Gives 0 of the 12 instructions most docs writing skills give in 295 tokens
Counted across 1,637 of the 3,044 authors here whose files we hold, read 2026-08-07
- Announce the skill at startin 54 of 1637, across 26 files
- Convert legacy doc files before editingin 45 of 1637, across 7 files
- Predict questions readers might askin 42 of 1637, across 4 files
- Generate clarifying questions for initial contextin 42 of 1637, across 3 files
- Create document scaffold with placeholder textin 42 of 1637, across 3 files
- Brainstorm content options for each sectionin 42 of 1637, across 3 files
- Test the document with a fresh context-less instancein 42 of 1637, across 3 files
- Include exact file paths in every taskin 42 of 1637, across 15 files
- Ask interview questions one at a timein 42 of 1637, across 27 files
- Apply surgical edits during refinementin 41 of 1637, across 2 files
- Offer structured workflow or freeformin 40 of 1637, across 1 file
- Ask for document meta-contextin 40 of 1637, across 2 files
Said here and by no other author read
- Define document readers, scenarios, location, and update triggers
- Distinguish user, developer, operations, API, and decision documents
- Write security boundaries and approval steps for sensitive content
- Output clear, verifiable, maintainable documentation in Chinese
- Include document goals, target audience, and recommended structure
- Provide executable body content
Grouped from the skills themselves: near-identical wordings counted once, and counted by distinct author, so one author publishing three of these counts once. Length counted with cl100k_base; the agent that loads this file may tokenize it differently.