用途:帮助编写清晰、可维护的技术文档,覆盖 README、API 文档、架构决策记录(ADR)和用户指南四类文档。核心原则包括:文档即代码,与代码同版本、同评审;以读者为中心写作;可维护性优先于完整性,不准确的文档比没有文档更糟;链接到唯一事实来源,避免重复信息。
主要能力:提供各文档类型的模板与模式,并附带参考文件:readme-guide.md(README 模板、章节模式、徽章)、api-docs.md(API 文档模式、OpenAPI 集成)、adr-guide.md(ADR 格式与工作流)、diagrams.md(常见场景的 Mermaid 图模式)、readme-template.md、adr-template.md。
使用方式:先识别文档类型(README、API 文档、ADR、用户指南),确定受众(所有用户、开发者、团队、贡献者),再按对应模板撰写,包含可运行并经过测试的示例,并链接相关文档。该技能由 /work 在文档类任务中调度。
适用场景:项目入口 README、端点参考 API 文档、重大决策 ADR、面向终端用户的任务型指南。
限制:不适用于行内代码注释(直接添加注释即可),也不用于 API 设计(应使用 api-design,本技能只记录已有 API)。具体安装命令、收费与平台信息暂未提供。