github 中 README.md 文件的写法

• 返回

各个分段和描述内容

• 项目简介：用一两句话简单描述该项目所实现的业务功能；

  相关描述信息***

• 技术选型：列出项目的技术栈，包括语言、框架和中间件等；

  相关描述信息***

• 本地构建：列出本地开发过程中所用到的工具命令；

  相关描述信息***

• 领域模型：核心的领域概念，

  相关描述信息***

• 测试策略：自动化测试如何分类，哪些必须写测试，哪些没有必要写测试；

  相关描述信息***

• 技术架构：技术架构图；

  相关描述信息***

• 部署架构：部署架构图；

  相关描述信息***

• 外部依赖：项目运行时所依赖的外部集成方，

  相关描述信息***

• 环境信息：各个环境的访问方式，数据库连接等；

  相关描述信息***

• 编码实践：统一的编码实践，比如异常处理原则、分页封装等；

  相关描述信息***

• FAQ：开发过程中常见问题的解答。

  相关描述信息***