doc-governance

Installation
SKILL.md

文档工程与知识库治理技能 (Documentation Governance Skill)

概述 (Overview)

在 AI 智能体软件研发时代,文档不再只是人类工程师的静态备忘录,更是智能体执行架构推演、接口对齐与 TDD 编码的核心上下文(Context Window)与真理源

doc-governance 是面向现代软件工程与 AI 智能体协作的一体化文档治理体系,立足于四大理论基石:

  1. Diátaxis 四象限架构:依据读者心智划分 Tutorials、How-To、Reference、Explanation,严禁职责混杂;
  2. RFC 提案孵化与结晶流转模型 (RFC-to-Crystallization Lifecycle):解决初期对齐高认知阻抗难题,初期单文件集中孵化,定案后解构结晶下沉;
  3. Docs-as-Code 与自动化 CI 门禁:物理链接校验、5 条滑动窗口自愈、零 404 断链与机器可读索引生成;
  4. 语言习惯继承与命名标准:尊重工程主语言连续性,初期推荐 kebab-case 规范,杜绝割裂。
graph TD
    Trigger(["📚 doc-governance 触发"]) --> Select{"选择运行模式"}

    Select -->|"模式 1: 伴随式全向联动 (Sync Mode)"| M1["比对变更集 (Git Diff) ➔ 推导受影响文档<br/>同步 API/模型/规则 ➔ 关闭待办 ➔ 更新 Changelog"]
    Select -->|"模式 2: 全局健康巡检 (Audit & Heal Mode)"| M2["静态扫描 404 断链 ➔ 修订历史滑动裁剪<br/>Frontmatter 合规校验 ➔ 自动生成 llms.txt"]
    Select -->|"模式 3: 脚手架与生命周期 (Scaffold & Archive Mode)"| M3["一键生成 Diátaxis / RFC 标准模板<br/>执行定案结晶下沉 ➔ 提案历史归档防腐"]
Installs
5
GitHub Stars
1
First Seen
4 days ago
doc-governance — codingrookie98/cr-agent-arsenal