参考
本区只放 lookup-oriented 文档,也就是“查字段、查入口、查路径、查接口”。如果一篇文档主要是帮助读者连续理解系统,请放到系统页或概念页,不要放在这里。
本区适合放什么
- API 入口图
- 配置来源与优先级
- 存储职责分层
- 数据模型与关键状态字段
- 代码入口索引
本区不适合放什么
- 完整系统叙事
- 产品操作手册
- 历史演进说明
- 以“为什么这样设计”为主的架构讨论
包含内容
使用规则
- 参考页不承担系统叙事主线
- 系统页引用参考页,而不是反过来让读者从字段表自己拼架构
- 每页都应服务于“快速定位”,不是把系统页内容压缩重写一遍