SuperAPI AI 工具集

documentation-writing

写作与研究

查看项目

更新于 10-15 17:19

技能介绍

用途:该技能用于编写高质量、易发现的软件文档,遵循 Eight Rules 和 Diataxis 框架,确保文档位置正确、相互链接,并包含真实可运行示例。当用户提到“write documentation”“create docs”“document this feature/module/API”“create a README”“write a tutorial”“explain how this works”或任何创建 Markdown 文档的请求时自动激活。

主要能力与核心规则:Eight Rules 为强制规则——所有文档放在 docs/ 目录;每份文档至少被另一份文档链接;使用平实语言精简措辞;使用可运行代码而非 foo/bar 占位符;每个文件只属一种 Diataxis 类型(tutorial/howto/reference/explanation);使用描述性标题、长文加目录;使用相对路径链接并附上下文;删除过时文档并包含更新元数据。文档中禁止放入状态报告、测试结果、会议记录、带日期的计划、时间点快照;临时信息应放在 CI 日志、GitHub Issues、PR 描述或提交信息中。

Diataxis 文档类型与位置:Tutorial 面向学习,位于 docs/tutorials/,回答“Teach me how”;How-To 面向任务,位于 docs/howto/,回答“Help me do X”;Reference 面向信息,位于 docs/reference/,回答“What are the options”;Explanation 面向理解,位于 docs/concepts/,回答“Why is it this way”。工作流为:确定文档类型、选择位置、用可运行示例编写、从 index 链接、按清单验证。

适用场景:创建 README、API 文档、教程、操作指南、参考和概念说明等。限制:文档不得包含时效性信息;避免“Click here”链接、foo/bar 示例、大段文字、孤立文档、文档内状态等反模式;文档驱动开发时可使用 [PLANNED] 标记,实现后移除标记并替换为真实示例。完整规范参见 reference.md,模板参见 examples.md。