Skip to content

Latest commit

 

History

History
34 lines (25 loc) · 1.24 KB

File metadata and controls

34 lines (25 loc) · 1.24 KB

文档导航

docs/ 目录用于承接新的仓库级说明文档,帮助第一次进入仓库的同学快速完成三件事:看懂结构、启动项目、知道接下来该往哪里看。

推荐阅读顺序

  1. getting-started.md:本地启动、联调与常用命令。
  2. repository-map.md:仓库目录职责、边界和维护约定。
  3. 原始课程文档:

文档分层

目录 定位
docs/ 仓库入口文档、开发者文档、协作说明。
doc/ 课程交付物、需求分析、架构设计与详细设计原稿。
PlantUML/ 设计图源文件与建模素材。

维护约定

  • 新增“仓库使用说明”时优先放在 docs/
  • 新增“课程交付文档”时继续放在 doc/ 对应分类下。
  • 图表源文件优先维护在 PlantUML/,文档中通过链接引用。

快速链接