SuperAPI AI 工具集

write-documentation

写作与研究

查看项目

更新于 10-16 06:20

技能介绍

用途:为人类读者编写或更新文档,包括 README、教程、操作指南、参考和解释类文档。它在基础实现任务规则之上增加文档纪律,强调读者是没读过代码、带着一个问题而来的人。

主要能力与要求:写作前先固定框架、受众和读者问题。框架只能选一种:教程(线性、手把手、无选择)、操作指南(单一任务的配方)、参考(穷尽式查阅、无叙述)、解释(讲原因)。受众要具体,例如“首次集成我们 SDK 的开发者”,并写出读者会怎么问的那个问题。开头约 100 词内要包含读者所需的操作,不要写项目历史或“开始之前”。每个示例都要按读者方式实际运行并粘贴捕获的输出;未运行的示例只是假设。每条行为声明都要引用 file:line,找不到就核实或删除。不要使用读者无法据以行动的模糊措辞,条件行为要说明条件。若代码与规格矛盾,应作为阻塞问题提出,而不是用文字掩盖。在任务范围内检索并协调描述同一区域的其他文档;范围外的矛盾作为发现候选。对每个改动文件运行项目的格式与文档检查命令并粘贴输出,命令从 AGENTS.md 解析,未定义时询问。不得对自己的工作写审查结论。

适用场景:人类阅读的文档。面向智能体的材料(指南、模板、工作流文档)受众不同,代码修改工作属于该库其他指南。

限制:这些是审查包检查的约定,编辑时没有强制机制。资料未提供具体安装命令、价格、平台或效果信息。