架构边界
当前实现的内部边界、local-only 约束,以及用户文档与贡献者文档的分工规则。
架构边界
当前 active boundary
CodeIQ 当前的 active boundary 是:#strong[单机 CLI + Local Registry + local query runtime]。
这意味着当前主线围绕以下能力收口:
- 共享本地 bundle store;
- declaration facts + software component facts;
- CycloneDX / SPDX SBOM 导出;
- semantic diff 与 policy check;
- 本机上的 query / MCP 工作流。
当前明确不做
- hosted registry / distributed replication / multi-node HA
- trust verifier / trust root / KMS
- 把 build / diff / check / publish 迁移成查询运行时职责
文档分工
用户文档(docs/src/content/docs/*)
- 只从使用角度出发;
- 只保留用户完成任务所需的概念和命令;
- 不暴露内部实现路径、设计争论、proposal 对账细节。
贡献者文档(docs/src/content/contrib/*)
- 记录架构边界、proposal 对账、release ledger;
- 记录 repo 级维护信息和文档维护约束;
- 允许引用 spec、repo 路径、实现与测试证据。
当前文档重构规则
- 侧边栏标签必须短、明确、可扫描;
- 用户文档优先回答“我现在怎么用”;
- 内部设计原理统一移动到贡献者文档;
- README 只保留项目入口,不承载内部设计说明。
Proposal 中哪些信息要继续保留?
对用户仍然有价值、并且应在用户文档中保留的信息包括:
- CodeIQ 的目标与适用场景
- 支持的仓库类型
- CLI 工作流与核心命令
- Bundle / Diff / Check / Query / SARIF / Registry / MCP 的使用视角说明
更偏内部的内容应保留在贡献者文档:
- proposal 与当前实现的对账
- schema / contract 的演进与设计取舍
- release ledger 与 active scope 说明