跳转到主要内容

这是本节的多页打印视图。 .

返回本页常规视图.

简介

了解项目以及它背后的核心思路。

第一次接触项目时,请从这里开始。

1 - 项目概览

说明项目做什么、服务谁,以及为什么存在。

请用对你的项目最短而有用的说明替换这一页。

要解决的问题

使用读者熟悉的语言描述问题。在读者理解项目价值之前,先不要陷入实现细节。

最终结果

说明用户采用项目之后,能够成功完成什么。

提示

一份好的概览,应该让读者在两分钟内决定是否继续了解。

2 - 架构

为读者提供一个稳定的项目心智模型。

记录贡献者在修改代码之前必须理解的少数组件。

系统地图

部分职责
接口接收用户输入并呈现结果
核心执行项目规则
适配器连接外部系统

边界

明确项目刻意不负责什么。清晰的边界可以避免文档承诺软件并未提供的能力。