agent-entrypoints
创建、优化或审查项目及模块级 AGENTS.md / CLAUDE.md 等 Agent 入口文档时使用。根据项目事实精简规则、设置按需读取指针,支持模块两入口布局,并检查规则是否可执行、入口是否冲突。
为新项目或尚未建立文档管理体系的已有项目,规划并建立文档入口、资料分工和维护方式。 用户要求“建立文档管理体系”“首次配置文档治理”时使用;暂保留只读文档审计、日志统计与归档。 单独优化 Agent 入口、日常同步或执行复盘,交给对应 Skill。
$ npx -y skills add qshanx/docs-governance --skill living-docs-governance --agent claude-codeHow it fires
How this skill gets triggered: by you, by Claude, or both.
/living-docs-governanceContext preview
The summary Claude sees to decide when to auto-load this skill.
为新项目或尚未建立文档管理体系的已有项目,规划并建立文档入口、资料分工和维护方式。 用户要求“建立文档管理体系”“首次配置文档治理”时使用;暂保留只读文档审计、日志统计与归档。 单独优化 Agent 入口、日常同步或执行复盘,交给对应 Skill。
name: living-docs-governance description: >- 为新项目或尚未建立文档管理体系的已有项目,规划并建立文档入口、资料分工和维护方式。 用户要求“建立文档管理体系”“首次配置文档治理”时使用;暂保留只读文档审计、日志统计与归档。 单独优化 Agent 入口、日常同步或执行复盘,交给对应 Skill。 metadata: origin: ECC
为尚未建立体系的项目确定:需要哪些文档、各自放什么、变化后更新哪里。一次性脚本通常不需要。
了解项目 → 整理并补齐 docs → 建立 MAP、STATUS → 接入 Agent 入口并检查。
1. **了解项目。** 定位项目根,读取现有入口、相关对话和已确认需求;有代码时核对实现与配置,并确认是否使用 Git。区分现状、计划与未知项,需求与代码冲突分别记录,关键缺口先澄清。
2. **整理并补齐 docs。** 读取[记录范围与模板](record-scope.md),调用 [docs-structure](../docs-structure/SKILL.md) 按职责组织现有资料。按实际需要补齐数据库、需求、设计、接口和验证文档,下表有对应专项 Skill 时调用;提供项目根、确认来源与范围,核对返回的路径和缺口。复用现有主记录,不编造内容,不为凑目录创建空文档。
3. **建立导航和状态。** 建立或完善 `CLAUDE_MAP.md`,写清任务对应的资料入口、非显然位置和误导目录;建立或完善 `PROJECT_STATUS.md`,记录当前风险、阻塞、待办、待验证项和删除提醒。已有同类载体就复用。使用 Git 的项目不默认新建或要求维护 LOG;已有历史保留,不删改,后续维护沿用已确认约定。无 Git 时按追溯需要决定是否建立 LOG。
4. **接入并检查。** 由 [agent-entrypoints](../agent-entrypoints/SKILL.md) 在共享入口写入实际路径和读取要求:开始任务先读 MAP 导航与 STATUS 风险/阻塞,再按任务下钻正文;采用本插件开发流程时指向总路由的“模块变更流程”,按 `docs-maintenance` 接好收尾维护约定。沿真实任务检查能否找到需求、实现与验证资料,核对职责、引用和重复主记录,执行入口检查及下方命令。交付实际路径、维护方式、验证结果与缺口,重复执行复用已有来源、编号与路径。
python3 <插件目录>/scripts/audit-docs.py --root <目标根> --scope full
非零先区分实际问题与检查器布局限制;只有确认检查器不支持项目已选布局时才报告限制;项目策略要求 LOG 却缺失、已有历史被删除或断链仍须处理,不视为布局限制。专项不可用时报告缺口,不递归启动 setup;未测宿主加载或自动触发时标明未验证,部分配置不称完整完成。
| 本次需要 | 读取并执行 | |---|---| | 产品需求、来源与基线 | [product-evolution](../product-evolution/SKILL.md),仅处理已确定范围 | | 判断是否需要架构文档并完善说明 | [architecture-docs](../architecture-docs/SKILL.md) | | 领域术语与重要决策 | [domain-modeling](../domain-modeling/SKILL.md) | | 跨端接口契约 | [contract-first](../../engineering/contract-first/SKILL.md) | | 测试资产与验证证据 | [test-collaboration](../../engineering/test-collaboration/SKILL.md) | | 资料落实后的 Agent 入口 | [agent-entrypoints](../agent-entrypoints/SKILL.md) |
复用已有授权,仅讨论方案时保持只读。setup 不包含业务实现,也不自动授权 Git 初始化、提交、推送、依赖安装或 Hook/CI 配置。获准安装 Hook 时检查 `core.hooksPath`,否则用 `git rev-parse --git-path hooks/pre-commit` 定位,不覆盖既有 Hook。
`docs-structure` 已纳入 documentation 分类;若部署环境缺少该 Skill,报告目录规划步骤未完成,不冒充已调用。
只检查项目健康证据时,执行[项目健康采集](supporting-files/project-health.md):采集项目入口、验证命令、CI 与显式回执,按需衔接既有专项 Skill。静态候选不代表验证通过;不检查全局配置或会话历史。
编写或优化 Skill、Agent 入口及 AI 按需读取的文档时,读取 `skills/documentation/writing-for-agents/SKILL.md`。传入已确认材料、目标与授权范围,按其方法组织内容并完成含义核对,再继续原有验证与同步;只读任务保持只读。
单项状态更新、路径修正与 LOG 追加不自动触发全文改写。仅在目标项目已启用此能力且入口配置在授权范围内时,通过 `agent-entrypoints` 留一行触发路标;不将规则全文导入项目入口。
当前 Agent 按任务读取对应流程,首次 setup 不展开以下审计和日志管理。宿主调用方式见[使用说明](../../../使用说明.md)。
尚未建立体系时执行[统一 setup](#统一-setup);已有体系的增量整理读取 [docs-maintenance](../docs-maintenance/SKILL.md),传入本次变化与范围。仅追加 `log: 一句话` 时读取[日志管理](log-management.md)。
读取 [docs-maintenance](../docs-maintenance/SKILL.md),传入阶段说明、相关会话与实际 diff。采用 PR 护栏时,再执行[阶段同步的 PR 护栏](audit.md#阶段同步的-pr-护栏)。
普通文档审计读取 [docs-audit](../docs-audit/SKILL.md);显式 `/governance-audit` 或兼容 scope(spine/context/adr/artifacts/full)读取[兼容文档审计](audit.md)。仅要求“全项目审计”不视为兼容 scope,各自沿用失败处理,默认不写文件。
读取[日志管理](log-management.md#日志归档与索引),按事件数量判断是否需要归档,沿用既有确认要求。
日志统计读取[日志复盘](log-management.md#日志复盘);从文档管理经历中提炼经验,读取 [docs-retro](../docs-retro/SKILL.md)。两者默认只读。
A knowledge, decision, and verification governance system for long-running AI-assisted projects. It turns a strong agent's one-off work into shared project capability that future agents can inherit, verify, and evolve.
创建、优化或审查项目及模块级 AGENTS.md / CLAUDE.md 等 Agent 入口文档时使用。根据项目事实精简规则、设置按需读取指针,支持模块两入口布局,并检查规则是否可执行、入口是否冲突。
用户要求整体检查项目治理规则的承载位置、精简常驻约束,或判断散落资料能否沉淀为 Skill、脚本或 Hook 时使用。只读识别主源、重复工作流与自动化缺口,给出证据和最小建议;单项文档维护直接使用已有专项 Skill。
判断项目是否需要架构文档,或生成、完善、审查 ARCHITECTURE.md 及已有架构说明。用于模块分工、状态归属、依赖关系或核心流程需要梳理时;依据项目证据记录结构,区分当前实现与已确认设计。
兼容旧 context-and-decisions 调用;领域术语与 ADR 的形成和修改统一转交随插件提供的 domain-modeling。
只读审计现有项目文档,检查资料散乱、入口难找、断链、内容过时、重复主源及当前与历史混用。用于用户要求“审计文档”“检查文档是否过时”“看看文档哪里乱”,或阶段交接前检查文档体系时。
作为面向长期 AI 协作项目的知识、决策与验证治理总入口,把优秀 Agent 的一次性工作沉淀为可继承、可验证、可持续演进的项目集体能力;根据用户意图把任务路由到活文档、领域上下文与…