项目概览
1. 文档用途
用于说明项目定位、适用范围、目标读者、核心能力和推荐阅读顺序。
2. 建议填写内容
- 项目名称、定位和一句话目标
- 面向的用户或团队
- 当前阶段和主要交付边界
- 相关系统、仓库或运行环境
3. 推荐正文结构
3.1 项目定位
说明项目解决什么问题、不解决什么问题,以及与其他系统的边界。
3.2 主要读者
列出最终用户、协作者、开发者、运维或管理者各自应该从哪里开始阅读。
3.3 推荐阅读顺序
用 3 到 5 条链接给出最常见的阅读路径。
4. 变更记录
| 日期 | 变更内容 | 变更人 |
|---|---|---|
| YYYY-MM-DD | 初始化模板 | 文档管理员 |