Hash‑Lock the SLA: Generate Reference, Freeze Policy

说明与用途

文档政策受到 AI 变更的保护：关键部分存储在单独文件中，使用哈希校验并在 CI 中验证，AI 生成器只能修改生成的引用。

问题

AI‑generated documentation can unintentionally alter or remove critical policy text such as SLAs, leading to incorrect or misleading promises in public docs.

结果

Policy sections in documentation are protected from AI drift, ensuring accurate SLA and other critical statements while still allowing automated generation of reference content.

工作流

• 1. Classify each README section as rebuildable reference or human policy using a decision table.
• 2. Create a docs.ownership.yml file listing sections, owners, freeze status, and source files.
• 3. Store frozen policy sections as raw files in docs/frozen/ and generate a SHA256SUMS file.
• 4. In the README, wrap sections with HTML comment markers (e.g., <!-- section:sla:start -->).
• 5. Run a CI validator script that extracts section bodies, hashes them, and compares to SHA256SUMS. Fail if mismatched.
• 6. When a policy change is needed, edit the corresponding frozen file, run the hash updater, and review the isolated diff. Do not ask the AI to refresh the README.

证据

If a human intends to change the SLA, they edit docs/frozen/sla.md, run the hash updater, and review that diff in isolation.

来源