如何写项目的ReadMe

README

        README主要是为了体现项目全景概览或项目描述，告知刚接触的新人，如何快速上手项目，降低沟通成本。

        README编写的原则：简明扼要，条理清晰，图文并茂。

        至少包含但不限于以下方面：

• 项目简介：以简短的说明描述项目业务、业务场景、目的；
• 演示地址：如果有，请提供；
• 技术选型：罗列项目的技术栈，建议包括语言、框架、中间件、其他信息等；
• 构建方法：罗列开发过程中所需使用的工具、命令、其他内容等；
• 领域模型：核心的领域概念。比如：电商系统，有Order、Goods/Products 等；
• 测试策略：自动化测试的分类。必要部分与非必要部分的区分；
• 技术架构：技术架构图、拓扑图等；
• 部署拓扑：部署拓扑图；
• UML示意：如果有，请提供；
• 外部依赖：项目运行时所依赖的外部三方组件。比如：订单系统依赖的会员认证系统；
• 运行环境：环境配置。各类环境的访问、数据库连接方式，环境配置与搭建等；
• 编码实践：统一的编码实践。比如：异常处理原则、注释格式等；
• FAQ：开发或搭建环境过程中遇到的常见问题与解决方法。

        说明：README中的信息可能随着项目的升级出现编号。例如，引入新的技术栈或者加入新的领域模型。因此，该文件的内容也需要持续更新。软件文档通常与项目实际进度较难保持同步，但就 README 的内容更新而言，依然建议开发者们多花时间进行编写，这是提高Star和Fork数的上上之选。