用途:撰写或更新技术文档,包括教程、操作指南(how-to)、参考(reference)与解释(explanation)四类,并覆盖 API 文档、ADR 与 runbook 模式。
主要能力:按 Divio 文档类型组织内容;统一风格与术语,使用主动语态;强调标题层级与可扫读性,示例优先;支持 Mermaid 内联图与 PlantUML(.puml)复用图;API 文档涵盖认证、请求/响应、错误码与破坏性变更;ADR 记录背景、决策与后果,runbook 记录步骤、回滚与联系人;支持交叉链接与文件名规范。
使用方式:写作前必须先阅读 references/documentation-guide.md,不得凭假设决定风格与结构。按需查阅该指南中的 Style and Voice、Structure and Skimmability、Doc Types (Divio)、API Documentation、ADRs and Runbooks、Visuals and Diagrams、Templates and Checklists、When to Document 等章节。可用 look_at 解读截图或图表,用 ui_to_artifact 从原型生成起始代码片段。完成后运行 bash skills/docs-check/scripts/check-docs.sh 校验文档完整性。
适用场景:新功能文档、API 变更、数据结构变更后的文档更新;与 ada::docs:check、ada::code-review、ada::code-quality 等技能配合使用。
限制:资料未提供具体安装命令、收费方式、支持平台与效果数据;实际写作标准以 references/documentation-guide.md 为准。