Skip to content
bitzorcas
中EN

Guide

项目治理与版本信息

查阅代码提交约定、文档维护方式、版本记录和后续投资方向。

Last updated

这里集中存放不属于某个运行模块、但会影响团队协作、版本解释和交付判断的资料。治理文档约束“怎样证明完成”,不会替代模块运行手册、源码事实或发布制品。

按任务选择页面

页面用途
代码提交规范分支、Commit、PR、Review 与敏感信息处理
最近更新按 lastUpdated 自动列出最近 30 天改过的页面
更新日志记录有可验证依据的主要交付变化
路线图区分已交付、待补证据和后续投资方向
文档维护事实来源、双语同步、链接和自然度检查

路线图不是承诺日期,更新日志也不替代 Git 历史和正式发布制品。对客户作出兼容性或交付承诺时,以版本化包、签名制品和 GA 证据为准。

五类事实不能混用

信息回答的问题主要证据
提交规范变更怎样进入主分支仓库规则、分支保护、CI
最近更新最近改过哪些说明书页面各页 lastUpdated、构建产物
更新日志某个已发布版本改变了什么Tag、包清单、SBOM、provenance
路线图下一步为什么值得投资风险、用户价值、缺口清单
文档维护如何防止说明书漂移源码扫描、双语校验、静态构建

变更前先做事实核查

Terminal window
# 确认目标仓库规则与当前工作树,避免把计划当成事实。
sed -n '1,220p' AGENTS.md
git status --short
git log -5 --oneline

如果页面涉及具体类型、配置键或运行顺序,还要在产品源码中定位声明与装配点;只搜到接口名不足以证明生产适配器已注册。

变更后留下可复验证据

Terminal window
# 说明书仓库的最小治理闭环。
npm run verify:docs
npm run verify:docs-source
npm run verify:docs-depth
npm run build
git diff --check

命令输出应进入 PR 说明或发布证据,而不是只写“已测试”。失败项不能通过降低页面状态、删除链接或把当前能力改写成规划来规避。

决策升级路径

发现源码与文档不一致时,先判断是文档夸大、实现缺陷还是仍在规划。文档夸大立即收缩;实现缺陷进入知识库/架构清单并明确 owner;兼容性、数据模型或跨模块边界变化通过 ADR 或正式架构记录决策。

完成定义

治理页完成至少意味着双语同步、事实来源明确、示例可复制、内部链接有效,并能解释尚未交付的边界。对外发布还必须通过 Consumer Contract 与 Commercial GA 门禁;治理文档本身不是放行证书。

100%

滚轮或按钮缩放 · 放大后拖动画面 · 双击切换 100% / 200%