文档编写器Skill doc-writer

文档编写器技能是一个自动化工具,用于根据预设模板和项目上下文,生成或更新软件开发项目中的任务文档。它遵循严格的命名和编号规范,确保文档结构一致性,并自动链接相关代码和资源,提升项目管理效率和文档维护质量。

DevOps 0 次安装 0 次浏览 更新于 2/28/2026

name: 文档编写器 description: 使用仓库上下文、DOC_TEMPLATE.md和命名规范创建或更新带编号的任务文档。

文档编写器技能

目的

使用规定的模板(docs/DOC_TEMPLATE.md)和现有仓库内容,生成或刷新 docs/planned/XX-*.mddocs/completed/XX-*.md 文件。

操作指南

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

验证

  • 确保新创建/更新的文档通过Markdown代码检查(如果已配置)并遵循 docs/DOC_TEMPLATE.md 的结构。
  • 确认编号序列保持唯一。