0002 · 文档基线
英文版本 为准,本文供参考。
状态:文档版本 D2;本次依赖规则补充由用户豁免审查;首次提交等待用户预览/确认。 本地 main 是仅文档首次提交的一次性例外,尚无远程或 PR。本基线建立简明、可审计的协作流程,网站实现仍是独立提议
。
本版本审查选择: D2 依赖规则补充的所有审查均由用户豁免,不记为通过;该选择不适用于未来任务。
需求
- 新增/升级直接依赖和工具时核实最新稳定版,固定精确版本,锁定传递依赖,CI 冻结安装;兼容性例外须由用户决定。
- 只交付文档与 Apache-2.0,README、协作规则、开发流程和变更记录均英文为主、简体中文参考。
- 每项变更用一对文章呈现需求、计划/决策、执行及验收,选中的审查内嵌其中;保留重要工程依据与验证,不写对话或文书流水账。
- 每个新功能/独立变更之前询问用户要做哪些审查;所有选中的独立审查检查正确性、第一性原理下的不必要复杂度、可维护性、日志价值和隐私。需求不清或需用户决定时暂停依赖工作。
- 仓库文件引用使用相对路径;公开文档及证据不得含个人隐私、本地绝对路径、凭据或原始会话。
- 后续变更从最新 main 在同级 worktree 开展,只通过 PR 集成;每次提交前准确预览暂存文件和完整信息,等用户确认。采用英文 Conventional Commits,多项实质改动须有 bullet-point 正文。
验收要求:五对语义一致的双语 Markdown 加 LICENSE,本地链接有效,规则简明一致,无不必要附件,并准确报告文档检查。应用测试、CI/CD、远程规则实施及部署不在本基线范围内。
计划与决策
- AGENTS 定义共享协作与依赖版本规则,
docs/workflow.md说明操作步骤,README 保持简短入口。 - 每项变更用一篇完整英文文章及中文参考;网站提议与文档基线交付范围不同,因此保留独立记录。
- 检查文件清单、链接、双语语义、空白和公开信息,遵循当前审查选择。
- 仅暂存预期的文档/许可,检查完整暂存差异,展示准确文件清单和英文信息;用户确认后才提交。
每项变更一篇文章,让决策和证据可连贯阅读。阶段分文件及强制快照/摘要框架增加导航与维护成本,却不服务本基线的验收标准。复用指南放 docs/,附件仅在增加证据价值时使用;未来通过 PR 链接及被审查 Git 版本追溯,无需重复仓库历史。
新增/升级时选最新稳定版,然后固定版本,兼顾引入时的版本新度与后续安装的可复现性;传递依赖保持锁文件中的兼容解析。
执行
- 共享版本规则覆盖应用包、工具链、Git 依赖及 CI Actions;本基线不包含依赖清单、锁文件、安装或具体版本核实。
- README 提供项目状态和文档入口;AGENTS 与开发流程规定每任务审查选择、第一性原理审查标准、公开信息规则、同级 worktree 及提交检查点。
- 每项变更用一对双语文章呈现有效需求、技术选择、交付状态和验收;网站提议明确区分计划行为与已交付工作。
- 本基线仅含五对文档与标准 Apache-2.0 LICENSE;这些纯文本变更不需要证据附件。
验收
在仓库根目录执行以下检查;这里的 Git 状态描述提交前检查点,并非仓库的永久状态。
| 检查 | 复现方式 / 预期结果 | 实际结果 |
|---|---|---|
| 范围 | rg --files --hidden -g '!.git/**' -g '!.agents/**' -g '!.codex/**':仅下方清单 | 通过:11 个文件、五对双语文档 |
| 语言及链接 | 逐对阅读 EN/ZH,确认规则等价;相对所在文件解析所有 Markdown 文件链接 | 通过:作者已检查语义一致,34 个本地链接全部有效 |
| 格式及隐私 | 检查全文的尾随空白、本地绝对路径、个人隐私、凭据、私有地址和原始会话 | 通过:无尾随空白,模式扫描及正文检查未发现隐私数据或本地绝对路径 |
| Git 检查点 | git branch --show-current 为 main;首次提交前 git rev-parse --verify HEAD 失败;git remote 为空 | 通过:main,无 HEAD 提交,无远程 |
| 暂存交付 | 运行 git diff --cached --check,检查完整暂存差异和准确路径;暂存内容须与清单、工作文件一致 | 通过:恰好 11 项暂存新增,与工作文件逐字节一致,无未暂存/未跟踪文件,空白检查通过 |
预期清单:README.md / README.zh.md、AGENTS.md / AGENTS.zh.md、docs/workflow.md / docs/workflow.zh.md、logs/changes/0001-repository-bootstrap/index.md / index.zh.md、logs/changes/0002-documentation-baseline/index.md / index.zh.md 和 LICENSE,共 11 个文件、五对双语文档。列表中的中文文章短文件名与其前面的英文文件位于同一目录。
未运行应用测试、Hugo 构建、浏览器验收、远程规则验证或部署;这些属于应用实现的验收工作。
审查记录
2026-09-13 — 独立审查者 final_documentation_review:通过,无阻断项。范围为文档版本 D1 的上述全部 11 个工作文件;检查双语一致性、正确性、第一性原理简化、日志价值、隐私和授权边界,并独立复验文件/链接/空白及 Git 状态。
D1 的通过结论不覆盖 D2 依赖规则改动;依照上述选择,D2 未进行审查。作者检查和暂存核实遵循上述验收标准,提交前仍须用户确认。