本目录是项目记录系统。新需求先从当前架构事实确认影响范围,再进入决策、计划、运行记录或历史材料。
| 需要了解 | 入口 |
|---|---|
| 多工程项目状态 | architecture/project-status.md |
| 数据平台:Dagster、dbt、ClickHouse raw/marts | architecture/data-platform.md |
| 数据治理:contracts、field glossary、data dictionary | architecture/data-governance.md |
| Furnace Rust 技术指标计算引擎 | architecture/furnace.md |
| Rearview Rust 规则选股后端服务 | architecture/rearview.md |
| Racingline Rearview 前端工作台 | architecture/racingline.md |
| 部署、迁移和运行记录 | architecture/deploy-ops.md |
| 目录 | 角色 | 当前性 |
|---|---|---|
architecture/ |
当前项目状态、架构边界、代码根、运行入口、质量门禁和 dbt layer 模型语义 | 当前事实入口 |
ADR/ |
长期决策 | 当前或明确标注状态 |
RFC/ |
设计讨论和历史方案 | 当前已统一归档到 archive/;活跃 RFC 需重新放顶层并标注状态 |
plans/ |
仍需执行的计划 | 顶层只放 active plans |
plans/archive/ |
完成、废弃或被替代的计划 | 历史参考 |
issues/ |
技术债、实现漂移、质量扫描和治理建议入口 | 历史参考 |
jobs/ |
runbook、snapshot 和运行报告入口 | 当前入口 |
jobs/reports/ |
实际运行事实 | 历史事实 |
releases/ |
集成 release note、版本 manifest schema 和 tag 前检查 | 当前入口 |
references/ |
外部接口、raw profile、data dict | 可查事实 |
Q&A/ |
设计问答、临时讨论和待升级为 RFC/ADR 的架构判断 | Proposed 或 Temporary |
skills/ |
可复用 agent 操作流程 | 当前 runbook |
计划和设计类文档使用 状态: 标记:
Proposed:已提出,尚未执行。In Progress:正在执行。Blocked:因明确外部条件暂停。Completed:已完成,等待归档或短期保留。Accepted:ADR 已接受。Superseded:被新文档替代。Archived:历史参考。
历史文档不要作为当前事实引用。引用历史方案时,同时链接当前架构事实文档、代码、ADR 或运行报告作为证据。
文档-only 变更至少运行:
make docs-check
git diff --check涉及 Dagster、dbt、contracts 或 Rust 的事实更新时,追加对应领域校验命令。
版本治理或发布快照变更追加:
make versions-check