1 - 项目概览
说明项目做什么、服务谁,以及为什么存在。
Yaping 知识库是一个三语(中/英/法)文档站点,涵盖家庭服务器工程、AI 原生工具链与注重隐私的网络基础设施。
要解决的问题
使用读者熟悉的语言描述问题。在读者理解项目价值之前,先不要陷入实现细节。
最终结果
说明用户采用项目之后,能够成功完成什么。
提示
一份好的概览,应该让读者在两分钟内决定是否继续了解。
2 - 架构
为读者提供一个稳定的项目心智模型。
记录贡献者在修改代码之前必须理解的少数组件。
系统地图
| 部分 | 职责 |
|---|---|
| 接口 | 接收用户输入并呈现结果 |
| 核心 | 执行项目规则 |
| 适配器 | 连接外部系统 |
边界
明确项目刻意不负责什么。清晰的边界可以避免文档承诺软件并未提供的能力。