文档规范助手
目标
只要出现“文档输出”(需求说明、设计说明、接口说明、测试报告、上线清单、排障记录、复盘总结等),必须:
- 内容非必要均使用中文
- 目录与文件名统一中文(允许数字与短横线)
- 输出位置统一在项目根目录 docs/ 下
- 缺陷统一归档在 docs/bug
- 同一需求多文档必须放入同一二级目录
- 有新增/修改需求时同步维护既有文档
全局可用约定
- 本技能与规则/模板以“可被任意项目引用”为前提:不依赖当前仓库的业务代码,只依赖目标项目的 repo-root 结构(docs/、.trae/)。
- 若你采用 D:\agentDocs 作为全局规范目录:目标项目可通过“复制模式/引用模式(Junction)”安装 .trae/rules、.trae/skills 与缺陷模板到目标项目,使本技能与规则在任意项目中一致生效。
触发条件(必须执行)
当用户提出以下任一诉求时,立即执行本技能:
- “写文档 / 出文档 / 生成报告 / 输出说明 / 形成总结 / 记录缺陷 / 写排障过程”
- 需要把分析、方案、测试结果整理成可交付材料并写入仓库
- 需要新增或更新 docs 下的任意 Markdown/Word/Excel/PDF/文本类文档
- 需求实现已完成/已交付,需要补齐“实现记录/交付记录”等可追溯材料
输出路径判定
- 缺陷类(bug/缺陷/故障):写入 docs/bug/缺陷记录.md(必要时可在 docs/bug 下补充单独说明文件,但仍需中文命名)
- 需求类(某个需求的说明/设计/测试/上线):在 docs/需求/ 下创建二级目录集中存放
- 目录推荐:YYYYMMDD-需求名称
- 文件推荐:主题名称.md(如:需求说明.md、接口说明.md、测试报告.md、上线清单.md、实现记录.md)
- 规范类(全局约定/制度/流程):放在 docs/规范/
输出内容要求
- 文档名与标题用中文
- 允许保留英文:协议名、标准术语、代码、命令、日志原文、接口字段名等必须保持原样的内容
- 文档首部必须包含“更新时间”,有多次改动时追加“变更记录”
- 优先更新既有文档,避免重复新建导致信息分散
更新时间与变更记录(统一口径)
- 更新时间:建议放在文档头部元信息区,格式 YYYY-MM-DD(或 YYYY-MM-DD HH:mm,按文档类型选用)
- 变更记录:当同一文档被多次修改时追加表格,至少包含【日期】【变更点】【负责人】
建议模板(Markdown)
推荐在文档开头包含:
- 标题
- 适用范围
- 更新时间
并在末尾包含(如适用):
- 变更记录(日期、变更点、负责人)
通用模板入口(推荐)
- 需求/接口/测试/上线等通用文档优先复用模板:docs/规范/文档输出-模板/(例如:需求说明模板、需求实现记录模板、接口说明模板、测试报告模板、上线清单模板、通用文档模板)。
- 当目标项目未包含该目录时:应先通过全局规范目录安装通用模板到目标项目的 docs/规范/ 下,再开始产出文档,保证结构一致、字段齐全、便于评审与追溯。
缺陷模板入口(推荐)
- 缺陷类文档优先复用模板:docs/bug/缺陷处理-模板/(例如:缺陷记录模板、修复方案模板、设计说明模板、任务清单模板、完成记录模板)。
- 当目标项目未包含该目录时:应先通过全局规范目录安装缺陷模板到目标项目的 docs/bug/ 下,再开始产出缺陷文档,以保持团队一致的结构与字段口径。
执行策略
- 若发现同类文档已存在:以“补充/修订”为主,合并内容后更新更新时间与变更记录
- 若需要新建:先创建目录结构,再生成文档并在 docs/索引.md 中补充入口(如新增了新的长期文档)