audit-document SKILL.md skillA

audit-document from devcodex-labs/devcodex is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.

Install it, pinned
mdr add devcodex-labs/devcodex/audit-document@git:20260908.6caf1bf

Pins git:20260908.6caf1bf in mdr.lock. Pin the fingerprint instead.

Audit grade
A, 17 of 17 checks passed
Kind
SKILL.md skill
Repository
devcodex-labs/devcodex
Path
content/skills/audit-document/SKILL.md
Versions recorded
2
Latest version
git:20260908.6caf1bf, committed Sep 8, 2026
First version recorded
Jul 30, 2026
Size
5,759 bytes
Repository stars
432
License
AGPL-3.0

通用文档审查维度 DA-1~DA-6 — README/架构文档/开发指南专属审查层.

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

# Audit Document Skill

## 适用范围

审查目标为**通用文档**(README、架构文档、开发指南,不属于规范/技术方案/需求/报告)时,叠加本 Skill(在 G1~G5 之后)。

用户侧文档、最终用户手册、站点文档、项目文档、菜单导航或文档 IA review 场景应优先使用 `audit-user-manual` 作为聚合入口;本 Skill 仍负责其中的通用文档审查维度。README / 主入口文档场景在本 Skill 基础上,还应叠加 `audit-readme`。

## 维度总览(DA-1~DA-6)

| 分组 | 维度 | 优先级 |
|------|------|:------:|
| A — 内容质量 | DA-1 结构完整性 · DA-2 内容准确性 | 🔴 |
| B — 引用与术语 | DA-3 引用有效性 · DA-4 术语一致性 | 🔴/🟡 |
| C — 受众与关联 | DA-5 受众适配 · DA-6 关联一致性 | 💡/🔴 |

## 核心检查维度

**DA-1 结构完整性 🔴**
- 有目录/大纲且与实际章节一致(无多余/遗漏)
- 章节间有逻辑连贯性(无突兀断层)
- 无未完成章节(标题存在但内容为空/"TBD")
- 标题层级合理(H1 唯一,逐级递进,无跳级)

**DA-2 内容准确性 🔴**
- 版本号/路径/技术栈与实际项目状态一致
- 代码示例可执行(语法正确,命令可运行)
- API/配置说明与代码实现匹配

**DA-3 引用有效性 🔴**
- 内部链接(相对路径)目标文件存在
- 外部链接可访问(不 404)
- 代码引用的文件/函数/类型存在

**DA-4 术语一致性 🟡**
- 同一概念在文档内用统一术语(不混用别名)
- 术语与项目 profile 定义一致

**条件用户文档 / 文档站门禁(差分入口)**

> 共享 Gate 分组与完整探针以 `../spec-governance/gate-registry.json` 与 Owner Skill `user-manual-authoring` / `audit-user-manual` / `expert-output-quality` 为准;本 Skill 在 DA-1~DA-6 之外只保留审查触发摘要,不复制用户手册 Gate 百科。

- 面向使用者的文档:从“这是什么 / 适合谁 / 第一次成功 / 常见任务 / 失败恢复 / 下一步”审查;术语首次解释;示例真实;正式用户文档不得降为内部笔记口吻
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint
mdr add devcodex-labs/devcodex/audit-document@sha256:df1b9621bd55923b

The line at the top of this page pins the label git:20260908.6caf1bf, 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_wuxmjkfpvopt7j6b.svg)](https://markdownregistry.com/a/art_wuxmjkfpvopt7j6b)

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

Versions

The registry has recorded 2 versions of this file, between Jul 30, 2026 and Sep 8, 2026, about one every 40 days.

versioncommittedcommitsizeaudit
git:20260908.6caf1bf latest2026-09-08 6caf1bf 5,759 BA view · diff
git:20260730.6ee304a2026-07-30 6ee304a 5,636 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 (5759 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

devcodex-labs/devcodex · 432 stars · license AGPL-3.0 · pushed 2026-10-27 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_wuxmjkfpvopt7j6b
GET https://markdownregistry.com/api/v1/resolve?ref=devcodex-labs/devcodex/audit-document
GET https://markdownregistry.com/api/v1/blob/df1b9621bd55923b36350e2bb7e8019d7be628b3d2834b95c26258eb3be0e875

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 devcodex-labs/devcodex

accessibility-i18n SKILL.md skill
devcodex-labs/devcodex · content/skills/accessibility-i18n/SKILL.md · 无障碍与国际化专家 Owner — 当任务涉及可访问性、键盘操作、焦点、屏幕阅读器、ARIA、语言地区、本地化、RTL、翻译资源、用户可见文案或多语言文档时使用;要求把包容性体验和本地化验证绑定到真实用户路径。
git:20260730.6ee304a · audit A · 432 stars
ai-agent-system-architecture SKILL.md skill
devcodex-labs/devcodex · content/skills/ai-agent-system-architecture/SKILL.md · AI Agent 系统架构专家 Owner — 当任务涉及 Agent 路由、工具调用、上下文管理、记忆、状态机、权限、人机协作、可观测性、回放验证或模型辅助治理时使用;要求把 Agent 行为设计成可解释、可恢复、可审计。
git:20260907.36d3d18 · audit A · 432 stars
ai-evaluation-engineering SKILL.md skill
devcodex-labs/devcodex · content/skills/ai-evaluation-engineering/SKILL.md · AI 评测工程专家 Owner — 当任务涉及模型/Prompt 评测、模型选择、黄金集、评分量表、LLM-as-judge、Judge 校准、重复采样、方差、质量-成本-延迟权衡、提示词回归或模型升级回归时使用;要求把概率性结果转化为可复…
git:20260730.6ee304a · audit A · 432 stars
analyze-default SKILL.md skill
devcodex-labs/devcodex · content/skills/analyze-default/SKILL.md · 默认分析工作流规范 — 只读多轮分析、代码事实优先、analyze-lite 关联联查与 PCV 收敛验证
git:20260730.6ee304a · audit A · 432 stars
analyze-research SKILL.md skill
devcodex-labs/devcodex · content/skills/analyze-research/SKILL.md · 技术调研子类型规范 — 技术选型/可行性评估/根因调查,只读工作流
git:20260730.6ee304a · audit A · 432 stars
api-contract-architecture SKILL.md skill
devcodex-labs/devcodex · content/skills/api-contract-architecture/SKILL.md · API 契约架构专家 Owner — 当任务涉及 public API、HTTP/SDK/CLI 契约、版本兼容、错误模型、分页过滤、幂等、Schema、类型、迁移或消费者影响时使用;要求先冻结消费者契约,再设计实现与验证。
git:20261021.9117d5c · audit A · 432 stars
api-verification SKILL.md skill
devcodex-labs/devcodex · content/skills/api-verification/SKILL.md · 接口验证规范 — 双产物(.http + .cjs)生成 + 自动化执行脚本
git:20260730.6ee304a · audit A · 432 stars
architecture-design SKILL.md skill
devcodex-labs/devcodex · content/skills/architecture-design/SKILL.md · 架构设计文档编排 Owner — 当用户要求架构设计、系统设计、技术架构或可指导开发、Review 与任务拆分的完整方案时使用;要求从业务流程反推节点、状态、数据、一致性、异常补偿、ADR 与实施任务。
git:20260917.1dd4525 · audit A · 432 stars
audit-common SKILL.md skill
devcodex-labs/devcodex · content/skills/audit-common/SKILL.md · 审查公共维度 G0~G5 + Profile Freshness Check — 所有 audit 子类型必先执行的基础维度层
git:20261018.fda4337 · audit A · 432 stars
audit-dimensions SKILL.md skill
devcodex-labs/devcodex · content/skills/audit-dimensions/SKILL.md · D1~D25 规范文件审查维度总览 — 规范库/specs 文件专属审查层
git:20261018.fda4337 · audit A · 432 stars
audit-execution-guide SKILL.md skill
devcodex-labs/devcodex · content/skills/audit-execution-guide/SKILL.md · 审查执行指南 — 维度优先级分批、定向审查子集、联动检查清单
git:20261017.e96e3c4 · audit A · 432 stars
audit-project SKILL.md skill
devcodex-labs/devcodex · content/skills/audit-project/SKILL.md · 项目工程审查维度 PE-1~PE-12 — 代码质量/项目结构/依赖安全/资源泄漏专属审查层
git:20260730.6ee304a · audit A · 432 stars

Every file in devcodex-labs/devcodex

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