Docs Governance

Read-only audit of a deliberately broken sample project

This demonstration uses a synthetic project, not customer data. The project has four small governance documents. CLAUDE.md links to docs/spec.md, which does not exist.

The packaged checker was run after extracting the ZIP into a separate installation directory. It returned exit code 1 and correctly reported the missing specification. Hashes of all four input documents were identical before and after the audit: no project file was modified.

Smallest useful next step

Confirm whether a specification already exists elsewhere, then update the link to the authoritative document. If there is no specification, record that gap and establish its scope before creating one. Re-run the audit after an authorized fix.

Complete deterministic output

{"schema_version":1,"scope":"full","requested_base_ref":null,"base_ref":null,"head_commit":null,"worktree_dirty":null,"status":"fail","exit_code":1,"counts":{"error":0,"fail":1,"unverified":3,"warning":0,"pass":9},"findings":[{"check":"spine.carrier","status":"pass","scope":"spine","message":"CLAUDE.md 存在","path":"CLAUDE.md","line":null,"evidence":{}},{"check":"spine.carrier","status":"pass","scope":"spine","message":"CLAUDE_MAP.md 存在","path":"CLAUDE_MAP.md","line":null,"evidence":{}},{"check":"spine.carrier","status":"pass","scope":"spine","message":"PROJECT_STATUS.md 存在","path":"PROJECT_STATUS.md","line":null,"evidence":{}},{"check":"spine.carrier","status":"pass","scope":"spine","message":"PROJECT_LOG.md 存在","path":"PROJECT_LOG.md","line":null,"evidence":{}},{"check":"spine.paths","status":"pass","scope":"spine","message":"脊柱与可选载体中的路径引用存在","path":null,"line":null,"evidence":{}},{"check":"status.deleted","status":"pass","scope":"spine","message":"删除区无复活","path":"PROJECT_STATUS.md","line":null,"evidence":{}},{"check":"log.append-only","status":"unverified","scope":"spine","message":"无 Git 提交基准，历史只追加完整性未验证","path":"PROJECT_LOG.md","line":null,"evidence":{}},{"check":"log.event-count","status":"pass","scope":"spine","message":"PROJECT_LOG 活跃事件 0 条，未超过 200","path":"PROJECT_LOG.md","line":null,"evidence":{"count":0,"threshold":200}},{"check":"context.carrier","status":"unverified","scope":"context","message":"CONTEXT.md 未创建；没有稳定领域词汇时无需补空壳","path":"CONTEXT.md","line":null,"evidence":{}},{"check":"adr.index","status":"unverified","scope":"adr","message":"docs/adr/ 尚未创建；ADR 按实际决策懒创建","path":"docs/adr","line":null,"evidence":{}},{"check":"links.local","status":"fail","scope":"artifacts","message":"Markdown 链接断裂：CLAUDE.md -> docs/spec.md","path":"CLAUDE.md","line":null,"evidence":{"target":"docs/spec.md"}},{"check":"tests.references","status":"pass","scope":"artifacts","message":"未发现跨文档 TEST-ID 引用","path":null,"line":null,"evidence":{}},{"check":"docs.orphans","status":"pass","scope":"artifacts","message":"docs/ 下未发现疑似孤儿文档","path":null,"line":null,"evidence":{}}]}

The output also marks unavailable Git history as unverified. Deterministic checks establish mechanical evidence; semantic review and host integration need their own checks.