用途:这是一份文档写作与更新的纪律指南,面向“人类会阅读的文档”,包括 README、教程、操作指南(how-to)、参考(reference)和解释(explanation)。它叠加在基础实现任务规则之上,但本身不适用于面向智能体的材料(如指南、模板、工作流文档),也不负责改代码的工作。
主要能力与要求:
- 写前先固定一个框架(tutorial、how-to、reference、explanation 四选一),把读者具体化,并写下读者会提出的那一个问题;中途若发现框架切换,说明应拆成两篇文档。
- 开头约 100 词内给出读者所要的动作,而非项目历史或铺垫。
- 每个示例都要按读者视角实际运行并捕获输出后再写入;未运行的示例只是假设。
- 每条行为断言都要引用 file:line,找不到行就先核实或删掉该断言。
- 不使用读者无法据此行动的模糊措辞(should、might、could);条件行为要说明条件。
- 在任务范围内核对本文改动触及的其他同主题文档,范围外的矛盾只能作为发现项。
- 对每个被改动的文件运行项目的 format 与 doc-lint 命令并粘贴输出(命令从 AGENTS.md 解析,未定义时询问);不得对自己的工作出具审查结论。
使用方式:开始前打开 references/task-template.md 复制到任务文件中,用它记录框架、受众、读者问题、待验证示例表、粘贴证据与自查,不要凭记忆重建结构。任务包本身使用 kit 的任务模板。
适用场景与限制:适合需要撰写或更新人类可读文档的任务;不适用于代码修改,也不适用于面向智能体的文档。文中未说明具体安装命令、收费方式或平台信息,相关事实暂未提供。