qshanx/docs-governance

Claude Code、Codex 与 ChatGPT 的文档驱动开发治理插件:防文档腐烂、维护上下文与决策、契约协作、测试与回归证据。

解决的问题

当 AI 帮助编写代码时,代码变得廉价可重新生成,但其背后的推理——为什么做出决定、测试证明了什么、哪些领域有风险——会丢失。每个新会话或代理最终都可能重新发现相同的结构,而 README 会过时,架构理由也会消失。docs-governance 将项目文档视为一个小型系统,保留已确认的上下文、决策和交接证据,使好的工作能在会话结束后存续,并成为可复用的项目能力。

工作原理

该插件不会强迫你编写更多文档,而是设置一个薄文档主干,包含四个文件,每个文件有单一职责:持久规则(CLAUDE.md)、导航和禁止触碰区域(CLAUDE_MAP.md)、当前健康和优先级(PROJECT_STATUS.md),以及仅追加的项目历史(PROJECT_LOG.md)。它尽可能复用现有来源,并保持现有 PRD/Spec 文件的权威性。系统通过一组聚焦的技能工作,你可以从 Claude Code、Codex 或 ChatGPT 中调用这些技能——例如,审计、架构文档、日常维护或为代理编写文档。审计默认是只读的;设置不会隐式安装钩子、初始化 Git、提交或推送。系统使用 Markdown 作为事实来源,并有一个可选的、可重建的 SQLite 索引,该索引被 gitignore。

适用对象

这适用于使用 Claude Code、Codex 或 ChatGPT 等工具运行长期 AI 辅助项目的团队和个人。当多个代理或会话需要共享对项目规则、决策和验证证据的一致理解时,以及当你希望避免在会话之间丢失上下文时,它尤其有用。

亮点

  • 默认只读审计:/governance-audit 生成报告,而不是自动重写。
  • 薄文档主干,每个文件有清晰的单一职责。
  • 复用现有 PRD/Spec 文件和现有导航;扩展保持可选。
  • 可选的 SQLite 索引可重建且被 gitignore;Markdown 仍然是事实来源。
  • 包括针对架构文档、变更影响、契约优先协作和模块回归的聚焦技能。
  • 编写为对代理友好:渐进式披露、完成标准和 AI 阅读文档的本地最终检查。

相关

  • 项目
  • 项目
  • 项目
  • 项目