2026-9-20【知识库】项目知识库建设实践

方法论沉淀

第一层:使用场景驱动(而非代码结构驱动)

├── 新人 onboarding → 端到端跑通指南
├── 日常开发 → 模块文档 + API 文档
├── 故障排查 → runbook + 真实 FAQ
└── 架构理解 → ADR + 术语表 + 数据流图

第二层:内容来源分级

├── L1: 从代码精确提取(API 路由、表结构、配置项)
├── L2: 从设计文档迁移(已有的概要设计、接口文档)
└── L3: 从团队经验沉淀(决策原因、踩坑记录)

第三层:持续维护机制

├── 每次 PR 要求同步更新文档
├── 每季度 review 文档准确性
└── ADR 随决策产生而记录

2026-9-20【知识库】项目知识库建设实践
https://zhangyingxuan.github.io/2026-9-20【知识库】项目知识库建设实践/
作者
blowsysun
许可协议