guides-writer

# 文档中术语确定与解释 - 项目名称：`references/` 目录下的第一层目录名称。如：`KMP`/`CMP`/`工具链` - 需求编号与需求名称：[项目名称] 目录下的第一层目录名称。如：`IR004：DFX能力构建`,其中`IR004`为需求编号，`DFX能力构建`为需求名称。如果后续提到`需求`，则默认从这层目录确认是什么需求。 - 设计说明书：[需求] 目录下的`设计说明书`文件夹下的所有文件都是当前需求的设计说明书。如：`references/KMP/IR004：DFX能力构建/设计说明书`，每个设计说明书代表着当前需求设计的一种能力。 - 开发指南写作模板：参照`assets/Templates/guide-template.md` - QA：[需求] 目录下的`QA`文件夹下的所有文件都是当前需求测试方案。如有重复，取日期最新的。 # 写作流程 当用户需要写开发指南文档时： ## 1. 确认必要信息 ### 1. 确定需求 - 用户需要提供需求编号或需求名称，如：`IR004：DFX能力构建`、`IR004`、`DFX能力构建`。 - 确认用户提供的需求信息是否存在。查阅：`references/[项目名称]/[需求编号与需求名称]`目录。 - 如果目录不存在，则提示用户需求不存在。 - 如果目录存在，则确认用户提供的需求信息是否与目录名称一致。 - 如果一致，则确认用户提供的需求信息为当前需求。 - 如果不一致，则提示用户需求信息错误。 ### 2. 确认开发指南写作模板是否存在 - 确认开发指南写作模板是否能正常加载。 - 如果能正常加载，则确认开发指南写作模板为当前需求的开发指南写作模板。 - 如果不能正常加载，则提示用户开发指南写作模板错误，要求用户检查模板是否存在，输入正确的模板地址。 ## 2. 分析当前需求的需求说明书 - 确认当前需求是否有需求说明书。如果有，则确认需求说明书是否与用户提供的需求信息一致。 - 如果一致，则确认需求说明书为当前需求的需求说明书。 - 如果不一致，则提示用户需求说明书错误。 - 读取并分析当前需求的需求说明书，提取开发指南写作模板中需要的信息。 ## 3. 分析当前需求的设计说明书 - 确认当前需求是否有设计说明书。如果有，则确认设计说明书是否与用户提供的需求信息一致。 - 如果一致，则确认设计说明书为当前需求的设计说明书。 - 如果不一致，则提示用户设计说明书错误。 - 读取并分析当前需求的设计说明书，提取开发指南写作模板中需要的信息。 ## 4. 分析当前需求的 QA 测试方案 - 确认当前需求是否有 QA 测试方案。如果有，则确认 QA 测试方案是否与用户提供的需求信息一致。 - 如果一致，则确认 QA 测试方案为当前需求的 QA 测试方案。 - 如果不一致，则提示用户 QA 测试方案错误。 - 读取并分析当前需求的 QA 测试方案，提取开发指南写作模板中需要的信息。 ## 5. 编写开发指南文档 - 如果开发指南写作模板正常加载，根据流程 2、3、4 的分析结果，填写开发指南写作模板中需要的信息。 - 按照开发指南写作模板的格式，编写开发指南文档。 ## 6. 将开发指南文档保存到项目目录中 - 将编写好的开发指南文档，依照项目的`AGENTS.md`规则，保存到`开发指南`目录下。 # 自检与确认 - 确认开发指南文档是否符合规范。 - 确认开发指南文档是否包含所有必要的信息。 - 确认开发指南文档是否符合项目的`AGENTS.md`规则。 - 禁止在开发指南文档中插入任何非[开发指南写作模板]中规定的章节内容。 - 禁止在开发指南文档中插入任何非[开发指南写作模板]中规定的章节标题。 - 禁止篡改[开发指南写作模板]中规定的章节标题与子标题。 - 禁止删除[开发指南写作模板]中规定的章节标题与子标题。 - 如果[开发指南写作模板]中规定的章节标题与子标题无法从当前需求的需求说明书、设计说明书、QA 测试方案中提取出来，则提示用户，并且在该章节标题与子标题下添加注释，说明该章节内容为空，待补充。