docs-maintenance SKILL.md skillA

docs-maintenance from qshanx/docs-governance is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.

Install it, pinned
mdr add qshanx/docs-governance/docs-maintenance@git:20261012.bd30f6e

Pins git:20261012.bd30f6e in mdr.lock. Pin the fingerprint instead.

Audit grade
A, 17 of 17 checks passed
Kind
SKILL.md skill
Repository
qshanx/docs-governance
Path
skills/documentation/docs-maintenance/SKILL.md
Versions recorded
2
Latest version
git:20261012.bd30f6e, committed Oct 12, 2026
First version recorded
Oct 11, 2026
Size
5,100 bytes
Repository stars
218
License
MIT

每轮任务结束时同步本次变化涉及的文档。由项目收尾约定或用户要求“同步文档”“收尾”“准备交接”时调用;也用于处理已发现的文档与项目事实冲突。.

Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.

What the file says

# 日常文档维护

让下一位使用者或开发者读到的说明与本次变化一致。只维护受影响的文档;只读任务只报告差异。

需要每轮自动接入时,由 `agent-entrypoints` 在项目共享入口配置以下约定,Skill 名替换为实际可读取路径,外部插件使用完整路径:

> 每轮完整任务结束、最终回复前,执行 docs-maintenance;没有相关变化就不改,只读任务只报告差异。

“一轮”指完整任务,维护本身不递归触发。入口约定由 Agent 执行,Skill 文件本身不会自动运行,也不自行安装 Hook。

## 1. 确定这次改变了什么

结合本轮对话、实际 diff 和确认材料,说清**什么行为变了、影响谁、依据是什么**,不只列改过的文件。例如“订单取消时限从 30 分钟改为 60 分钟”,会影响用户说明与验收条件。由模块变更流程进入时,复用任务基线、影响清单和回归结果。

区分已确认需求、实际实现、上线状态与验证结果;测试失败或未运行不能写成已验收。没有相关变化就说明无需同步;缺少 Git 基线时依据现有材料核对,标出无法确定的旧状态。

## 2. 找到受影响的说明,就地更新

先复用本轮有效影响分析:范围、版本及未提交变化一致,且包含该范围要求的审计结果;出现新变化、失败或未覆盖项时,不沿用旧结论,按 `skills/engineering/change-impact/SKILL.md` 的“按事实核对文档”补查。它提供候选与依据,本 Skill 判断并修改正文。沿项目入口补查相关说明;零命中不等于无影响。

对每处说明判断:**下一位读者照着做,是否还会得到文档承诺的结果?** 根据变化定位现有主记录:

| 本次变化 | 重点核对 |
|---|---|
| 功能、使用方式或操作命令 | README、使用说明及操作文档中的步骤和预期结果 |
| 接口、配置或数据结构 | 契约、接入说明和调用示例;旧用法是仍受支持,还是已失效?契约写法沿用 `contract-first` |
| 文件位置或模块关系 | MAP 和相关引用;架构变化交给 `architecture-docs` |
| 需求、决策或稳定约定 | PRD/Spec、ADR 或项目入口;分别按 `product-evolution`、`domain-modeling`、`agent-entrypoints` 处理 |
| 进展、风险或验证结果 | STATUS 对应条目;旧证据是否仍适用于当前版本?任务排期仍留 Tracker |
| 值得追溯的重要事件 | 沿用项目约定的历史主源,保留原因、确认依据和相关版本;已有 LOG 按约定追加,否则复用 PR/Issue/决策或能承载这些信息的 Git 记录,不另建流水,保留既有历史 |
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint
mdr add qshanx/docs-governance/docs-maintenance@sha256:5974a88e2073e7a5

The line at the top of this page pins the label git:20261012.bd30f6e, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.

Badge

mdr badge

[![mdr](https://markdownregistry.com/badge/art_mvsqn5mpiwt77id5.svg)](https://markdownregistry.com/a/art_mvsqn5mpiwt77id5)

2 badge image fetches in 30 days. What the badge shows.

Versions

The registry has recorded 2 versions of this file, between Oct 11, 2026 and Oct 12, 2026, more than one a day.

versioncommittedcommitsizeaudit
git:20261012.bd30f6e latest2026-10-12 bd30f6e 5,100 BA view · diff
git:20261011.856328d2026-10-11 856328d 5,106 BA view

Audit of the latest version

A  17 of 17 checks passed. Fixed automatic checks with no AI involved, so the same checks give the same answer every run.
  • pass: Frontmatter block present
  • pass: Frontmatter declares a name
  • pass: Frontmatter declares a description
  • pass: Size between 200 bytes and 200 KB (5100 bytes)
  • pass: No zero-width or bidi control characters
  • pass: No instruction hidden inside an HTML comment
  • pass: No link to an exfiltration or paste host
  • pass: No credential-shaped string
  • pass: No instruction to send local credentials anywhere
  • pass: No text hidden with inline styles
  • pass: No prompt-injection phrasing
  • pass: No curl or wget piped into a shell
  • pass: No recursive delete of root, home or parent
  • pass: No instruction to read or print local credentials
  • pass: No base64 blob over 200 characters
  • pass: No link to a raw IP address
  • pass: No script tag

Source

GitHub

qshanx/docs-governance · 218 stars · license MIT · pushed 2026-10-16 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_mvsqn5mpiwt77id5
GET https://markdownregistry.com/api/v1/resolve?ref=qshanx/docs-governance/docs-maintenance
GET https://markdownregistry.com/api/v1/blob/5974a88e2073e7a511594ce6e1951e0a0d7bc5da1081a574ea27d471f567961a

Your AI assistant does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.

Guides: the SKILL.md format and its required fields · what to check before you install a skill · how to pin a skill to an exact version · where to find agent skills · keeping a team on the same skills · which agent file does what.

More from qshanx/docs-governance

AGENTS.md AGENTS.md file
qshanx/docs-governance · AGENTS.md
git:20260905.c132f0a · audit A · 218 stars
CLAUDE.md CLAUDE.md file
qshanx/docs-governance · CLAUDE.md
git:20261011.ee7c4b9 · audit A · 218 stars
agent-entrypoints SKILL.md skill
qshanx/docs-governance · skills/documentation/agent-entrypoints/SKILL.md · 创建、优化或审查项目及模块级 AGENTS.md / CLAUDE.md 等 Agent 入口文档时使用。根据项目事实精简规则、设置按需读取指针,支持模块两入口布局,并检查规则是否可执行、入口是否冲突。
git:20261011.d6d08d8 · audit A · 218 stars
agent-workflow-governance SKILL.md skill
qshanx/docs-governance · skills/documentation/agent-workflow-governance/SKILL.md · 用户要求整体检查项目治理规则的承载位置、精简常驻约束,或判断散落资料能否沉淀为 Skill、脚本或 Hook 时使用。只读识别主源、重复工作流与自动化缺口,给出证据和最小建议;单项文档维护直接使用已有专项 Skill。
git:20261011.f94e359 · audit A · 218 stars
architecture-docs SKILL.md skill
qshanx/docs-governance · skills/documentation/architecture-docs/SKILL.md · 判断项目是否需要架构文档,或生成、完善、审查 ARCHITECTURE.md 及已有架构说明。用于模块分工、状态归属、依赖关系或核心流程需要梳理时;依据项目证据记录结构,区分当前实现与已确认设计。
git:20261012.bd30f6e · audit A · 218 stars
context-and-decisions SKILL.md skill
qshanx/docs-governance · skills/documentation/context-and-decisions/SKILL.md · 兼容旧 context-and-decisions 调用;领域术语与 ADR 的形成和修改统一转交随插件提供的 domain-modeling。
git:20261012.bd30f6e · audit A · 218 stars
docs-audit SKILL.md skill
qshanx/docs-governance · skills/documentation/docs-audit/SKILL.md · 只读审计现有项目文档,检查资料散乱、入口难找、断链、内容过时、重复主源及当前与历史混用。用于用户要求“审计文档”“检查文档是否过时”“看看文档哪里乱”,或阶段交接前检查文档体系时。
git:20261012.bd30f6e · audit A · 218 stars
docs-governance SKILL.md skill
qshanx/docs-governance · skills/documentation/docs-governance/SKILL.md · 作为面向长期 AI 协作项目的知识、决策与验证治理总入口,把优秀 Agent 的一次性工作沉淀为可继承、可验证、可持续演进的项目集体能力;根据用户意图把任务路由到活文档、领域上下文与…
git:20261012.bd30f6e · audit A · 218 stars
docs-retro SKILL.md skill
qshanx/docs-governance · skills/documentation/docs-retro/SKILL.md · 从对话、文档变更及审计记录中复盘文档管理的问题和经验,减少资料难找、同步遗漏、重复维护和旧说明误用。用户要求“复盘文档管理”“为什么文档总漏更新”“总结文档治理经验”,或项目约定文档管理阶段复盘时使用;默认只读,输出有证据、适用条件和落点的…
git:20261011.8300772 · audit A · 218 stars
docs-structure SKILL.md skill
qshanx/docs-governance · skills/documentation/docs-structure/SKILL.md · 规划、整理或只读审查项目文档结构时使用。按职责聚合同类资料,明确当前主源、历史归档与按需读取入口。
git:20261011.1b07eb2 · audit A · 218 stars
domain-modeling SKILL.md skill
qshanx/docs-governance · skills/documentation/domain-modeling/SKILL.md · Build and sharpen a project's domain model. Use when discussing codebase terminology, writing or editing a CONTEXT.md…
git:20261012.bd30f6e · audit A · 218 stars
living-docs-governance SKILL.md skill
qshanx/docs-governance · skills/documentation/living-docs-governance/SKILL.md · 为新项目或尚未建立文档管理体系的已有项目,规划并建立文档入口、资料分工和维护方式。 用户要求“建立文档管理体系”“首次配置文档治理”时使用;暂保留只读文档审计、日志统计与归档。 单独优化 Agent 入口、日常同步或执行复盘,交给对应…
git:20261012.bd30f6e · audit A · 218 stars

Every file in qshanx/docs-governance

Browse by kind, by grade A, or by owner.