GPD govern-project-docsDocumentation governance GitHub
OPEN SOURCE / MIT CODEX SKILL + NODE.JS

文档不该
互相打架。

为人类维护者和 AI Agent 建立同一套可信知识边界。

One active authority.
Less context, more certainty.

查看源代码 开始使用
govern-project-docs / audit SYSTEM HEALTHY

READ-ONLY AUDIT

把知识边界
变成机器可检查的规则。

0
runtime dependencies
12
automated tests
2×2
OS / Node matrix

01 Start with a report. Change nothing until the authority is clear.

01 唯一活跃权威

02 渐进式检索

03 确定性索引

04 CI 持续约束

01 WHY IT EXISTS

真正昂贵的不是缺文档，
而是不知道该信哪一份。

A / 01

同一事实，多处维护

状态散落在 README、计划、交接记录和状态页。一次修改，留下多个过期版本。

duplicate truth

B / 02

机器契约，被手工转述

API、Schema 与依赖信息复制到 Markdown 之后，开始和真正的系统悄悄漂移。

authority drift

C / 03

上下文很多，答案很少

AI Agent 读取大量历史噪声，才能找到完成当前任务真正需要的少量事实。

context waste

02 THE WORKFLOW

三步，把文档从内容堆积
变成工程系统。

  1. 01AUDIT

    先看清

    只读扫描重复标题、失效链接、缺失元数据、陈旧路径和归档候选。

    audit-docs.mjs --repo .
  2. 02GOVERN

    再定权威

    定义当前事实、来源证据、参考材料、生成内容与历史记录的边界。

    authority → routing → evidence
  3. 03ENFORCE

    持续守住

    生成稳定索引，让 CI 持续检查链接、治理规则和索引新鲜度。

    generate · check · query

03 / GOVERNANCE MODEL

从混乱到可信，
每一步都有边界。

迁移旧知识、指定唯一权威、按需检索、归档证据。规则不是写在墙上的口号，而是进入自动化检查的系统约束。

阅读完整治理模型
DOCUMENTATION FLOWv0.2
从文档混乱到可治理知识：审计、迁移、索引、执行的完整流程
deterministicauditableagent-ready

04 / ONE-COMMAND TOOLKIT

一条命令，
先跑一次只读审计。

推荐 Node.js 22 或 24。直接通过 npx 从 GitHub 运行；审计不会修改目标仓库，适合先发现问题、评估范围，再决定如何治理。

  • 01 Authority Engine / schema v2
  • 02 Windows + Linux / Node 22 + 24
  • 03 Atomic init / no runtime dependencies
TERMINAL
# Run the read-only audit without cloning
$ npx github:CH-ZHOU-0512/
  govern-project-docs audit --repo .

Documentation audit
  Missing document IDs  0
  Authority conflicts   0
  Broken local links    0
  Status                ready

OPEN SOURCE / MIT

让下一次迭代，
不再增加文档债务。

安装为 Codex Skill，或把零依赖运行时工具接入现有仓库。

获取项目 加入讨论