详细设计:文档体系结构
这份设计文档说明当前 11Vue学习/组件化思维 目录的文档结构、信息分层和文件职责。
设计目标
目标不是简单存放 Markdown,而是建立一套可持续扩展的文档信息架构。
这套结构需要满足四个要求:
- 新读者可以快速找到入口
- 旧案例可以被统一检索
- 新案例可以平滑加入
- 过程性资料可以独立沉淀
分层结构
当前文档体系分成四层。
第一层:导航层
职责:帮助读者先定位问题,再找到合适案例。
文件:
Vue重构案例导航图.md
第二层:方法层
职责:提供统一的 Vue 重构框架。
文件:
Vue练习项目重构统一框架.md
第三层:案例层
职责:承载具体场景的拆解与落地方案。
当前案例:
待办应用核心逻辑重构.md点餐页购物车联动重构.md说说应用发布与互动链路重构.md表单组件校验体系重构.md表格列扩展渲染体系重构.md树组件递归与勾选联动重构.md
第四层:过程层
职责:记录项目规划、设计依据和开发复盘。
目录:
docs/
文件命名规则
为了保持目录可读性,这里采用两套命名规则:
根目录文档
根目录文档使用自然语言标题命名,适合直接阅读和链接。
适用对象:
- 导航文档
- 方法论文档
- 案例文档
docs/ 过程文档
docs/ 目录下使用编号前缀,体现执行顺序。
当前规则:
00-:里程碑与规划01-:结构设计02-:执行设计03-:开发记录
链接策略
为了让体系稳定,当前采用单一入口汇总策略。
主入口:
笔记.mdREADME.md
链接方式:
笔记.md提供最短导航README.md解释项目结构导航图负责按问题检索统一框架负责按方法理解
扩展策略
以后新增案例时,建议严格按下面顺序落位:
- 先写案例文档
- 再补进导航图
- 再判断统一框架是否需要补方法
- 最后在
docs/03-开发记录中补充本轮开发记录
这样能保证每新增一篇内容,整个体系都能保持同步更新。
