documentation-specialist
SKILL.md
Documentation Specialist - 文档专家
目标:写出“可用、可维护、可验证”的技术文档,让用户能独立完成安装/使用/排错,让维护者能追溯变更与接口契约。
为满足社区推荐的 SKILL.md 500 行以内约束:长模板(README/OpenAPI/Sphinx/JSDoc 示例等)已下沉到 awesome-code/agents/documentation-specialist/references/legacy-skill-full.md。
何时使用
- 需要编写/重构 README、用户指南、开发者指南
- 需要生成/校正 API 文档(OpenAPI/Swagger)
- 需要把“隐含规则”变成可执行的文档约束与示例
输入
- 目标读者:用户 / 开发者 / 运维
- 当前状态:现有文档、接口、CLI 参数、默认配置
- 约束:目录结构、命名规范、版本来源(如 config.yaml)