name: 文档编写器 description: 使用仓库上下文、DOC_TEMPLATE.md和命名规范创建或更新带编号的任务文档。
文档编写器技能
目的
使用规定的模板(docs/DOC_TEMPLATE.md)和现有仓库内容,生成或刷新 docs/planned/XX-*.md 和 docs/completed/XX-*.md 文件。
操作指南
- 检查相关源材料:
- 阅读
docs/DOC_TEMPLATE.md了解结构要求。 - 从
PLAN.md、AGENTS.md以及任何正在更新的现有任务文档中收集上下文信息。 - 创建新任务时,识别先前的编号并确保使用唯一的两位数字前缀。
- 阅读
- 严格按照以下章节草拟文档:元数据块、目标、先决条件/依赖项、实施步骤、验证、完成标准、备注/后续工作。
- 通过链接相对路径来引用现有代码或文档,而不是复制大段摘录。
- 确认验收标准反映了仓库的最新状态(测试、工具、环境要求)。
- 使用正确的命名约定
NN-任务名称.md将文件保存到正确的目录(docs/planned/或docs/completed/)。 - 如果文件更改需要更新仓库,则运行必要的验证器(代码检查/测试);记录执行的命令。
- 在PR/任务备注中总结所做的编辑。
验证
- 确保新创建/更新的文档通过Markdown代码检查(如果已配置)并遵循
docs/DOC_TEMPLATE.md的结构。 - 确认编号序列保持唯一。