文档地图
1. 四大模块
1.1 入门说明
面向第一次接触项目的人,回答“这是什么、先看什么、怎么开始”。
1.2 用户指南
面向最终用户和协作者,回答“怎么安装、怎么配置、怎么使用”。
1.3 开发者指南
面向开发者和集成方,回答“怎么开发应用、怎么扩展插件、有哪些函数和接口可以稳定调用”。
1.4 项目开发文档(内)
面向项目负责人、产品、架构、研发、测试、交付和运维,回答“需求是什么、设计是什么、过程怎么推进、风险怎么控制、怎么发布和运维”。
2. 内部项目文档子结构
项目开发文档(内) 下按过程阶段继续拆分:
- 项目治理
- 调研与决策
- 需求
- 设计文档
- 开发过程文档
- 测试与验证
- 发布与交付
- 运维与维护
- 演进复盘
- 追踪矩阵
3. 使用规则
- 不把用户文档写进内部过程文档。
- 不把开发者稳定接口说明混进内部设计细节。
- 需求、设计、发布、运维、追踪矩阵等过程性文档,只放在
项目开发文档(内)。