docs-audit SKILL.md skillA
docs-audit from qshanx/docs-governance is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add qshanx/docs-governance/docs-audit@git:20261012.bd30f6ePins 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-audit/SKILL.md- Versions recorded
- 5
- Latest version
- git:20261012.bd30f6e, committed Oct 12, 2026
- First version recorded
- Oct 11, 2026
- Size
- 5,542 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
# 文档审计 检查现有资料是否找得到、可信、职责清楚。默认只读，不移动、改写或删除文件；修复获准后交给相应维护流程。 ## 1. 扫描文档，了解现有组织 确认项目根、受检版本与用户限定范围。默认盘点整个项目的自有文档，不只看 docs；排除依赖和构建产物，生成文档单独识别。先看路径、标题和现有索引，再按主题读正文，不一次加载全部资料。 识别项目入口、主题目录、当前说明、草稿与历史记录，以及它们之间的引用。列明未能读取或未覆盖的部分；不能把未读内容当作已检查。 ## 2. 检查入口与引用，能否找到正确资料 从项目实际的 AGENTS／CLAUDE、README 或 MAP 出发，选“查接口”“改数据库”等适用任务，沿指针找到正文。检查失效路径、断链、无入口的重要文档，以及能打开却指向旧版的链接；有意不放在总导航的内部资料不直接判错。 复用项目已有只读检查；本插件的路径与链接检查可运行 `python3 <插件目录>/scripts/audit-docs.py --root <项目根> --scope artifacts`。记录命令、范围与结果；检查失败后，继续独立且可安全核实的部分，依赖失败环节或缺失证据的部分标为未完成，说明影响范围。脚本通过仍需判断导航是否有用；失败提示不授权修改文件。 ## 3. 核对内容，是否仍适用于当前项目 ### 核心模块的知识入口覆盖 在受检范围内，从已有架构、导航、业务职责和代码证据识别核心业务模块，不按目录大小或文件数推定。逐个检查并列明未覆盖模块： - 必要职责、状态边界、接口和验证约定能否从现有主记录明确定位并覆盖该模块，且遵守项目级规则。局部 AGENTS、根入口中的明确模块章节或既有架构主记录都可作为落点；根入口已充分覆盖且无新增局部规则时标“复用／有效”，如实说明没有独立局部文件。只有必要约定确实未覆盖，或项目明确要求局部入口而未满足时才报缺口；不为补文件数量创建空壳。 - 是否有对应 CONTEXT，或明确链接到共享业务词汇表；前后端共用一份是有效覆盖，不强迫复制。没有领域专属词时可列“不适用”并给依据；有待澄清术语却没有主记录时列“缺失”。 - 是否只是空模板、链接是否有效、职责与术语是否混写或重复；入口质量按 `agent-entrypoints`、术语质量按 `domain-modeling`、文档与代码边界按 `architecture-docs` 核对，不在此复制其方法。 输出“核心模块及识别依据｜规则主记录／局部入口或复用路径｜CONTEXT 主记录／复用路径｜有效、缺失、不适用或未验证｜建议”。模块归属不明或资料不可读时标未验证，不臆造缺失结论。存在文件不等于覆盖有效；静态审计脚本也不自动完成此语义核对。 …
Read the whole file at its exact version.
How to install
mdr add qshanx/docs-governance/docs-audit@sha256:8b04921c23799c04The 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.
[](https://markdownregistry.com/a/art_vyjnat5mskw7pgg2)
3 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 5 versions of this file, between Oct 11, 2026 and Oct 12, 2026, more than one a day.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| git:20261012.bd30f6e latest | 2026-10-12 | bd30f6e | 5,542 B | A | view · diff |
| git:20261011.c5f9740 | 2026-10-11 | c5f9740 | 5,548 B | A | view · diff |
| git:20261011.d6d08d8 | 2026-10-11 | d6d08d8 | 5,272 B | A | view · diff |
| git:20261011.189b128 | 2026-10-11 | 189b128 | 3,676 B | A | view · diff |
| git:20261011.1f7ae10 | 2026-10-11 | 1f7ae10 | 3,532 B | A | view |
Audit of the latest version
- pass: Frontmatter block present
- pass: Frontmatter declares a name
- pass: Frontmatter declares a description
- pass: Size between 200 bytes and 200 KB (5542 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
qshanx/docs-governance · 218 stars · license MIT · pushed 2026-10-16 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_vyjnat5mskw7pgg2 GET https://markdownregistry.com/api/v1/resolve?ref=qshanx/docs-governance/docs-audit GET https://markdownregistry.com/api/v1/blob/8b04921c23799c044f352d85831ba5481c60ceec01db18cd71379f87790d8212
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
Every file in qshanx/docs-governance