docs-governance
CLAUDE.md320 starsChanged 32 days agoMITView on GitHub
面向长期 AI 协作项目的文档治理插件,维护项目规则、知识、决策与验证证据,支持后续 Agent 接手。 进会话读取(分级):本文件全文 + PROJECT_STATUS.md 红线块;MAP / ARCHITECTURE / LOG 按需。 本插件*刻意保持轻量治理——它自己的 skill 写着"别给小项目过度治理",这套四件套就是个薄示范*,别往里堆。
- Commits and pushes
1 other project uses a version of this.
Adopted by
Most recently taken up by
- qshanx/docs-governanceword for word, first seen Oct 11, 2026
Other versions1 project uses a version of this.
Word for word · 1
- qshanx/docs-governance★ 253100% same
Edited · 0
None found.
Wrote their own version · 0
None found.
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
In this repository20 other files it gives its agents.
- AGENTS.mdAGENTS.md
- agent-entrypointsSkill
- agent-workflow-governanceSkill
- architecture-docsSkill
- context-and-decisionsSkill
- docs-auditSkill
- docs-governanceSkill
- docs-maintenanceSkill
- docs-retroSkill
- docs-structureSkill
- domain-modelingSkill
- living-docs-governanceSkill
- module-governanceSkill
- product-evolutionSkill
- writing-for-agentsSkill
- change-impactSkill
- contract-firstSkill
- loop-design-checkSkill
- module-regressionSkill
- test-collaborationSkill
The file
Files
CLAUDE.md — docs-governance 插件自治理(用自己的方法论治自己)
面向长期 AI 协作项目的文档治理插件,维护项目规则、知识、决策与验证证据,支持后续 Agent 接手。
进会话读取(分级):本文件全文 +
PROJECT_STATUS.md红线块;MAP / ARCHITECTURE / LOG 按需。 本插件刻意保持轻量治理——它自己的 skill 写着"别给小项目过度治理",这套四件套就是个薄示范,别往里堆。
硬规则
- 方法论唯一源在
skills/<category>/<name>/SKILL.md;agent / command 只指过去,不复制方法论(防插件自己内部漂移)。 - 生成、修改或审查 Agent 入口时执行
skills/documentation/agent-entrypoints/SKILL.md的八条检查;AGENTS.md/CLAUDE.md每份不超过 200 行,细节下沉后保留路标。 - 修改后在仓库根目录激活已有
.venv,运行受影响的检查;共享审计器、公共接口变化或提交前运行bash scripts/verify.sh,绿了才提交。同一输入的有效结果可复用,不因收尾重复全量运行;首次环境准备见 TESTS.md。 - 创建或更新 PR 前:提交完本轮改动后运行
python3 scripts/check-pr-docs.py --base <实际目标分支>;失败先修复,并按输出核对关联文档。推送与 PR CI 再检查同一提交快照。 - 文件名 kebab-case;治理正文默认中文,现有英文文档、代码标识及技术术语保留原语言。
- commit message 用英文;
git push等小磊说。 - 涉及跨模块行为、公共契约、共享数据或影响不明的变更前,读取
skills/documentation/docs-governance/SKILL.md的“模块变更流程”,完成影响分析、实施后对照、相关回归和按需文档同步后再交付。普通小任务只做相关修改与检查,文档事实未变不更新 MAP、LOG 或 TESTS。
路标
- 路径导航 / 误导清单 / 别动区 →
CLAUDE_MAP.md - 当前 Module 权责、状态归属、依赖与核心流转 →
ARCHITECTURE.md - 当前健康 / 待办 →
PROJECT_STATUS.md - 值得追溯的重要事件 →
PROJECT_LOG.md - 调用治理能力、未指定专项 Skill → 先读
skills/documentation/docs-governance/SKILL.md,按意图选择对应 Skill,不全量加载。 - 编写或优化 Skill、Agent 入口及 AI 按需读取的文档 → 读取
skills/documentation/writing-for-agents/SKILL.md,完成后按其补充核对含义。 - 架构 / 数据库决策 →
docs/adr/README.md - 涉及产品目标、需求、实现或验收 → 先从 产品管理入口 定位当前基线,再按
skills/documentation/product-evolution/SKILL.md的“按任务读取”核对当前需求和受影响条款;不默认全文加载产品目录。 - 文件归位与触发条件 →
.docs-governance.json,说明见references/document-policy.md - 给用户怎么用 →
README.md/使用说明.md
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

