Skip to content

六类模块文档模板 ​

templates-module/ 只维护模块六类文档类型的通用模板。用户要求记录新模块业务基线或开始新模块实施时,先在 requirements.md 记录事实、范围和未决项;进入设计、数据库、验证或用户操作阶段且确有内容时,再建立对应文件。仅要求讨论或审阅时只交付结论;独立讨论稿、需求对焦稿、前期方案及任务性专项报告放在项目根 reports/,不使用模块模板建立站内稿件。requirements.md 是业务规则与范围的单一正文,其他文件按职责记录并链接引用。

新模块入口 ​

新模块在授权记录或实施过程中按阶段建立以下六类文档:先以需求分析记录范围、来源、合理假设及待确认事项;进入设计、数据、验证或用户操作阶段时,按实际需要建立对应文件。未进入的阶段不创建空文件,不适用的内容不占位;正式对外交付或版本验收时补齐适用资料。旧模块尚缺六类结构的,后续按模块迁移;普通局部开发只维护受影响资料。模板如下:

  1. 需求分析模板;
  2. 概要设计模板;
  3. 详细设计模板;
  4. 数据库设计模板;
  5. 测试与验收模板;
  6. 操作手册模板。

六类文档类型共同构成完整模块资料,文件按对应阶段建立并随需求、设计、实现和验收进度完善;建文件不表示实施完成或验收通过。文档头部只保留 文档版本 与 最近核对日期,版本按文档版本规则递增,模板默认从 0.01 起。不建立单独的模块简报、执行记录、交接包或流水式变更日志。

模块当前业务事实和文档版本在六类文档中维护,实现与验收结论记录在对应 test-report.md 和交付回报中;数据库字段、来源和核验时间归入对应模块的 database-design.md;当前结构以项目纳管数据库回读为准。公共交付规则见软件交付文档,平台运行见平台部署方案。真实凭证和个人信息不得进入模板或公开文档站。

复制模板到模块目录后,将已建立的关联文档链接指向该模块的 requirements.md、overview-design.md、detailed-design.md、database-design.md、test-report.md 或 user-manual.md;尚未建立的文件不添加失效链接。仅保留适用章节,设计文档说明验证重点,测试与验收文档记录实际结果和证据。