系统基线
稳定文档
沉淀平台架构、服务边界和长期有效的工程决策。
RGB 内部文档
RGB 平台内部工程文档中心
面向研发、运维、QA 和交付协作，统一维护 RGB 平台的架构说明、服务边界、 决策记录、变更方案和生产运行手册。文档内容与仓库同步，作为内部工程协作的正式参考。
文档治理原则
- 以仓库 Markdown 为唯一来源，所有修改通过 Git 留痕。
- 架构、服务边界和生产操作要求保持可审查、可追踪。
- 破损链接和构建错误在 CI 中阻断发布，避免失效文档进入站点。
- 规格、计划和运行手册按变更生命周期归档，保留决策背景。
变更治理
变更文档
记录迁移方案、功能改造、实施计划和上线步骤。
运维支撑
支持材料
归档参考资料、历史证据和文档模板，支撑日常协作。
使用方式
内部协作路径
处理架构评审、服务改造、生产问题或上线准备时，优先从稳定文档建立上下文， 再进入对应变更材料和运行手册。
- 架构总览：确认系统拓扑、领域边界和核心数据流。
- 服务手册：定位具体服务的职责、入口、依赖、worker 和运行方式。
- 决策记录：理解关键设计取舍，避免只根据当前代码状态倒推原因。
- 规格说明与实施计划：确认变更目标、范围、验收标准和执行状态。
- 运行手册：在本地、测试环境或生产操作前核对步骤和风险点。
- 参考资料：用于补充证据、历史迁移和外部资料，不替代当前正式设计。