SuperAPI AI 工具集

doc-governance

写作与研究

查看项目

更新于 10-15 20:13

技能介绍

用途:面向软件工程与 AI 智能体协作的文档治理体系,把文档作为智能体执行架构推演、接口对齐与编码的核心上下文与真理源。

主要能力:以 Diátaxis 四象限(tutorials、how-to、reference、explanation)划分文档职责;用 RFC 提案孵化与结晶流转模型管理初期对齐与定案下沉;通过 Docs-as-Code 与 CI 门禁做链接校验、修订历史滑动窗口裁剪与机器可读索引生成;支持 MADR 架构决策记录与 Backlog 冷热隔离归档。

使用方式:提供三种运行模式。伴随式全向联动(Sync Mode)用 git diff --name-only 比对变更集,按变更联动矩阵同步 API、模型、规则、UI 文档,更新 changelog 与 backlog,并运行 check-doc-links.py、check-doc-control-sync.py 校验。全局巡检与自愈(Audit & Heal Mode)运行 python3 scripts/check-doc-links.py --root docs、python3 scripts/check-doc-control-sync.py --root docs、python3 scripts/trim-revision.py --root docs --fix --keep 5、python3 scripts/audit-doc-health.py --root docs、python3 scripts/generate-llms-txt.py --root docs --output docs/llms.txt。脚手架与归档(Scaffold & Archive Mode)运行 scripts/scaffold-doc.sh <type> <name> 生成模板,定案后按 rfc-crystallization-lifecycle.md 下沉并归档原 RFC。

适用场景:API/契约/模型变更、业务规则与状态机变更、核心架构决策、项目初期需求对齐、PR 合并门禁、历史目录迁移至 Diátaxis。

限制:纯代码内部单行重构或仅修复语法警告且不涉及外部行为契约变动时无需触发。reference 不得混入教学或未定案草案;引用须保留 .md 后缀相对路径;修订历史限最近 5 条;单文档原则上不超过 800 行;backlog 不得堆积已关闭条目。具体脚本参数与模板细节以资料所列参考手册为准,其余未提供。