Diagram Design
cathrynlavery/diagram-design
Creates branded diagrams, from architecture, flowchart and sequence to charts and maps, as self-contained HTML with inline SVG, with import from draw.io, Mermaid and Excalidraw.
通用文档审查维度 DA-1~DA-6 — README/架构文档/开发指南专属审查层. An agent skill from devcodex-labs/devcodex.
Install Audit Document
$ npx skills add devcodex-labs/devcodex --skill audit-document -a claude-codeProject install by default; add -g for ~/.claude/skills/.
$ gh skill install devcodex-labs/devcodex audit-document --agent claude-codeProject scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).
$ git clone --depth 1 https://github.com/devcodex-labs/devcodex.git skills-src && mkdir -p .claude/skills && cp -r skills-src/content/skills/audit-document .claude/skills/audit-document && rm -rf skills-srcUse ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.
Claude Code skills documentation · loads skills from .claude/skills/
Install the "audit-document" agent skill from https://github.com/devcodex-labs/devcodex/tree/main/content/skills/audit-document into .claude/skills/audit-document/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "audit-document", then confirm the skill loads.Claude Code copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$skill-installer install https://github.com/devcodex-labs/devcodex/tree/main/content/skills/audit-documentType this inside Codex. $skill-installer <name> installs a curated skill from openai/skills. The installer writes to $CODEX_HOME/skills (default ~/.codex/skills). Restart Codex if the skill does not show up.
$ npx skills add devcodex-labs/devcodex --skill audit-document -a codexProject install goes to .agents/skills/; add -g for ~/.codex/skills/.
$ gh skill install devcodex-labs/devcodex audit-document --agent codexProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/devcodex-labs/devcodex.git skills-src && mkdir -p .agents/skills && cp -r skills-src/content/skills/audit-document .agents/skills/audit-document && rm -rf skills-srcUse ~/.agents/skills/ instead of .agents/skills for a personal install.
Codex skills documentation · loads skills from .agents/skills/
Install the "audit-document" agent skill from https://github.com/devcodex-labs/devcodex/tree/main/content/skills/audit-document into .agents/skills/audit-document/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "audit-document", then confirm the skill loads.Codex copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add devcodex-labs/devcodex --skill audit-document -a cursorProject install goes to .agents/skills/; add -g for ~/.cursor/skills/.
$ gh skill install devcodex-labs/devcodex audit-document --agent cursorProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/devcodex-labs/devcodex.git skills-src && mkdir -p .cursor/skills && cp -r skills-src/content/skills/audit-document .cursor/skills/audit-document && rm -rf skills-srcUse ~/.cursor/skills/ instead of .cursor/skills for a personal install.
Cursor skills documentation · loads skills from .cursor/skills/, .agents/skills/, .claude/skills/, .codex/skills/
Install the "audit-document" agent skill from https://github.com/devcodex-labs/devcodex/tree/main/content/skills/audit-document into .cursor/skills/audit-document/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "audit-document", then confirm the skill loads.Cursor copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gemini skills install https://github.com/devcodex-labs/devcodex.git --path content/skills/audit-document--scope user (default) or --scope workspace; --path is the subfolder of the repo that holds the skill; --consent skips the security confirmation prompt.
$ npx skills add devcodex-labs/devcodex --skill audit-document -a gemini-cliProject install goes to .agents/skills/; add -g for ~/.gemini/skills/.
$ gh skill install devcodex-labs/devcodex audit-document --agent gemini-cliProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/devcodex-labs/devcodex.git skills-src && mkdir -p .gemini/skills && cp -r skills-src/content/skills/audit-document .gemini/skills/audit-document && rm -rf skills-srcUse ~/.gemini/skills/ instead of .gemini/skills for a personal install, then run /skills reload.
Gemini CLI skills documentation · loads skills from .gemini/skills/, .agents/skills/
Install the "audit-document" agent skill from https://github.com/devcodex-labs/devcodex/tree/main/content/skills/audit-document into .gemini/skills/audit-document/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "audit-document", then confirm the skill loads.Gemini CLI copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gh skill install devcodex-labs/devcodex audit-documentInstalls for Copilot at project scope by default; add --scope user for a personal install. Preview a skill first with gh skill preview. Needs GitHub CLI 2.90.0 or later (public preview).
$ npx skills add devcodex-labs/devcodex --skill audit-document -a github-copilotProject install goes to .agents/skills/; add -g for ~/.copilot/skills/.
$ git clone --depth 1 https://github.com/devcodex-labs/devcodex.git skills-src && mkdir -p .github/skills && cp -r skills-src/content/skills/audit-document .github/skills/audit-document && rm -rf skills-srcUse ~/.copilot/skills/ instead of .github/skills for a personal install. Commit .github/skills so cloud agent and code review can use it.
GitHub Copilot skills documentation · loads skills from .github/skills/, .claude/skills/, .agents/skills/
Install the "audit-document" agent skill from https://github.com/devcodex-labs/devcodex/tree/main/content/skills/audit-document into .github/skills/audit-document/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "audit-document", then confirm the skill loads.GitHub Copilot copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add devcodex-labs/devcodex --skill audit-document -a opencodeOpenCode documents no install command of its own. Project install goes to .agents/skills/; add -g for ~/.config/opencode/skills/.
$ gh skill install devcodex-labs/devcodex audit-document --agent opencodeProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/devcodex-labs/devcodex.git skills-src && mkdir -p .opencode/skills && cp -r skills-src/content/skills/audit-document .opencode/skills/audit-document && rm -rf skills-srcUse ~/.config/opencode/skills/ instead of .opencode/skills for a personal install.
OpenCode skills documentation · loads skills from .opencode/skills/, .claude/skills/, .agents/skills/
Install the "audit-document" agent skill from https://github.com/devcodex-labs/devcodex/tree/main/content/skills/audit-document into .opencode/skills/audit-document/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "audit-document", then confirm the skill loads.OpenCode copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
Facts
- Skill name
audit-document- GitHub stars
- 439
- Token cost
- ~863 tokens
- SKILL.md length
- 234 words
- Files
- 2
- Skills in repo
- 70
- Repo updated
- First seen
- Licence
- AGPL-3.0
At a glance
通用文档审查维度 DA-1~DA-6 — README/架构文档/开发指南专属审查层. An agent skill from devcodex-labs/devcodex.
- Works in 5 steps: 先执行 DA-1~DA-6 → 若用户要求用户侧文档 review、项目文档、菜单导航或信息架构审查，先通过… → 再叠加 audit-readme 的 RM-1~RM-6 → …
- Tasks that involve Technical documentation
- SKILL.md covers 适用范围, 维度总览（DA-1~DA-6）, 核心检查维度 and README 叠加规则, plus 4 more sections
- Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md
What it does
Audit Document is an agent skill from devcodex-labs/devcodex. 通用文档审查维度 DA-1~DA-6 — README/架构文档/开发指南专属审查层
Its SKILL.md is about 860 tokens, which your agent loads only when the skill is triggered. The skill folder holds 1 other file (for example `intent.json`).
It sits in Development, covering Technical documentation. The repository describes itself as: Intent-driven AI coding workflow runtime for consistent context, skills, approvals, validation, and handoffs across six AI coding hosts. The licence is AGPL-3.0.
When your agent uses it
- Tasks that involve Technical documentation
Example prompts
- “/audit-document”
Workflow steps
5 steps, taken from the first numbered list in SKILL.md.
- 先执行 DA-1~DA-6
- 若用户要求用户侧文档 review、项目文档、菜单导航或信息架构审查，先通过 audit-user-manual 聚合证据
- 再叠加 audit-readme 的 RM-1~RM-6
- 通用结构/准确性问题留在 DA-*
- 用户路径、快速开始、示例真实度、开发信息后置与消费链一致性问题留在 RM-*
What it can do on your machine
Read from SKILL.md and the folder at commit 1dd4525. It shows what the files ask for, not the result of running them.
Tool permissions
Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.
From allowed-tools in the SKILL.md frontmatter.
Runs code
No scripts in the folder and no shell commands in SKILL.md.
From the folder's file list and the shell code blocks in SKILL.md.
Network
No URLs in SKILL.md.
From URLs in SKILL.md, links to its own repository left out.
Credentials
Names no API keys, tokens, secrets or passwords.
From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.
Context cost
Audit Document loads about 863 tokens when it runs. Until then it costs about 14 tokens; SKILL.md has 234 words of instructions outside code blocks.
Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.
Safety
Auto-check passed
The automated check found no risky patterns in SKILL.md.
Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.
SKILL.md
The full file from devcodex-labs/devcodex at commit 1dd4525, republished under its AGPL-3.0 licence (© devcodex-labs). 234 words, ~863 tokens.
Download SKILL.mdSave it as
.claude/skills/audit-document/SKILL.md (or your agent's skills folder). This skill also uses 1 other file; get the full folder from GitHub.- name
- audit-document
- description
- 通用文档审查维度 DA-1~DA-6 — README/架构文档/开发指南专属审查层
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 Skilluser-manual-authoring/audit-user-manual/expert-output-quality为准；本 Skill 在 DA-1~DA-6 之外只保留审查触发摘要，不复制用户手册 Gate 百科。
- 面向使用者的文档：从“这是什么 / 适合谁 / 第一次成功 / 常见任务 / 失败恢复 / 下一步”审查；术语首次解释；示例真实；正式用户文档不得降为内部笔记口吻
- 用户手册 / 站点文档 / README：优先经
audit-user-manual聚合；核对主受众、落点、IA、真实工作流与消费者同步；未发布能力不得用开发文档冒充用户手册 - 多语言 / 正式边界：信息等价与导航顺序；正式面不混台账/复盘；“已验证/可点击”须有实际命令或页面证据
- 流程图 / 生成站点 / 示例语义 / 专家产物：运行态或生成产物证据，而非仅 Markdown；示例可追溯 public type/runtime；fixture 不得描述成生产推荐路径；不适用写
N/A + skipReason
README 叠加规则
当目标是 README 或主用户使用文档时：
- 先执行
DA-1~DA-6 - 若用户要求用户侧文档 review、项目文档、菜单导航或信息架构审查，先通过
audit-user-manual聚合证据 - 再叠加
audit-readme的RM-1~RM-6 - 通用结构/准确性问题留在
DA-* - 用户路径、快速开始、示例真实度、开发信息后置与消费链一致性问题留在
RM-*
维护者站点维（DA-M · 条件）
当审查目标为维护者/贡献者开发文档站（docsAudience=maintainer-dev 或 CONTRIBUTING/dev/internals 主路径）时，在 DA-1~DA-6 之上追加：
| 检查 | 要求 |
|---|---|
| DA-M1 可执行 dev 路径 | 具备 clone/环境/依赖安装与 test 或 build 命令之一；不得仅产品介绍 |
| DA-M2 受众一致 | 主叙事服务维护者；不得伪装成用户安装手册却无用户第一次成功路径 |
| DA-M3 命令可信 | 关键命令与 package.json/仓库脚本不矛盾，或标明 N/A 理由 |
| DA-M4 漂移 | 模型按维护者实际任务审查正文，形成与正文摘要绑定的 review；classifyDocsAudienceDriftSample('maintainer-dev', body, review) 只校验绑定并投影结论，unverified 不代表通过 |
用户站审查仍优先 audit-user-manual；本维不替代用户站聚合入口。
N/A 规则
- 纯图表/示意图文件无受众概念：DA-5 标 N/A
- 无关联代码：DA-6 标 N/A
- 未触发用户手册 / 文档站 / 多语言 / 生成站点 / 示例语义 / 专家产物时：对应条件门禁聚合写
N/A + skipReason（完整 Gate 名见 registry / Owner Skill） - 未触发维护者站：DA-M 聚合
N/A + skipReason=not-maintainer-docs - 公开主路径若展示旧兼容路径或 DSL/parser 示例：分别检查副作用兼容边界与最小执行探针（Owner：
user-manual-authoring/dev-docs）
同步锚点（validate / consumer）
ExpertOutputQualityGate · fixture/mock/demo
额外同步锚点
UserManualProductizationGate · UserManualRenderedFlowAndRealWorkflowProbe · DocsThemeRuntimeVisualProbeGate · BehaviorSemanticDocsParityGate · NegativeTranslationParityProbe · DocsExampleTruthSurfaceGate · CallbackExampleScopeProbe
<!-- auto-sync anchors -->DocumentationTranslationParityGuard · FormalDocsDevCodexBoundary · LiveVerificationExecutionObligation · FlowchartNodeExplanationGate · DocsSiteVisualAcceptanceGate · UserPerspectiveDocsGate · DocsConsumerSweep · 低心智负担 SideEffectCompatibilityDocsGate · ExecutableExampleTruthProbeGate · UserDocsImmediateComprehensionGate · UserDocsPrimarySurfaceGate · 未发布 runtime · FinalUserManualFirstGate · DocsSiteInformationArchitectureGate · UserManualFlowAndFailureGate · GeneratedSiteGate · ManualTocDuplicationGate · UserPathContractSweep · PublicUserDocsMaintainerBoundaryGate
© devcodex-labs, AGPL-3.0. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file
Files
SKILL.md and 1 other file in content/skills/audit-document of devcodex-labs/devcodex.
- SKILL.md
- intent.json
Open the folder on GitHubat commit 1dd4525
Compare with similar skills
Audit Document next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.
| Skill | Stars | Used in | Tokens | Auto-check | Licence | Repo updated |
|---|---|---|---|---|---|---|
| Audit Document this skilldevcodex-labs/devcodex | 439 | — | ~863 | Automated safety check: Pass | AGPL-3.0 | |
| Diagram Designcathrynlavery/diagram-design | 45k | 1 repos | ~7.5k | Automated safety check: Pass | MIT | |
| Simple Englishmoeru-ai/airi | 50k | 2 repos | ~4.6k | Automated safety check: Pass | MIT | |
| Get API Docs with chubandrewyng/context-hub | 14k | 2 repos | ~775 | Automated safety check: Pass | MIT | |
| Doc SyncJetBrains/ideavim | 10k | 2 repos | ~2.6k | Automated safety check: Pass | MIT | |
| Mailspring App ScreenshotsFoundry376/Mailspring | 18k | — | ~1.5k | Automated safety check: Pass | GPL-3.0 |
Similar skills
Simple English
moeru-ai/airi
Write or rewrite technical text with the rules of ASD-STE100 Simplified Technical English so it is clear, unambiguous, and free of AI slop.
Get API Docs with chub
andrewyng/context-hub
Fetches current documentation for third-party APIs and SDKs with the chub CLI before the agent writes code against them, instead of relying on remembered API shapes.
- Official
Doc Sync
JetBrains/ideavim
Keeps IdeaVim documentation in sync with code changes. An agent skill from JetBrains/ideavim.
Mailspring App Screenshots
Foundry376/Mailspring
Captures screenshots of the running Mailspring dev app for docs, PRs or visual checks by launching it with a debugging port, driving the UI and clipping to an element.
Draw.io Diagram Studio
Agents365-ai/drawio-skill
Creates and edits editable draw.io diagrams from descriptions, code, infrastructure files, SQL and API schemas, with sync, review, test and export tools.
More from devcodex-labs/devcodex
All 70 skills in this repoAccessibility I18n
devcodex-labs/devcodex
无障碍与国际化专家 Owner — 当任务涉及可访问性、键盘操作、焦点、屏幕阅读器、ARIA、语言地区、本地化、RTL、翻译资源、用户可见文案或多语言文档时使用；要求把包容性体验和本地化验证绑定到真实用户路径。
AI Agent System Architecture
devcodex-labs/devcodex
AI Agent 系统架构专家 Owner — 当任务涉及 Agent 路由、工具调用、上下文管理、记忆、状态机、权限、人机协作、可观测性、回放验证或模型辅助治理时使用；要求把 Agent 行为设计成可解释、可恢复、可审计。
API Contract Architecture
devcodex-labs/devcodex
API 契约架构专家 Owner — 当任务涉及 public API、HTTP/SDK/CLI 契约、版本兼容、错误模型、分页过滤、幂等、Schema、类型、迁移或消费者影响时使用；要求先冻结消费者契约，再设计实现与验证。
Architecture Design
devcodex-labs/devcodex
架构设计文档编排 Owner — 当用户要求架构设计、系统设计、技术架构或可指导开发、Review 与任务拆分的完整方案时使用；要求从业务流程反推节点、状态、数据、一致性、异常补偿、ADR 与实施任务。
Audit Common
devcodex-labs/devcodex
审查公共维度 G0~G5 + Profile Freshness Check — 所有 audit 子类型必先执行的基础维度层
Audit Session
devcodex-labs/devcodex
审计工作流的跨会话状态机 — 在 <audit-root/.audit-state/<session-id.json 持久化轮次/发现项/收敛状态，支持 Token 中断后精准恢复
Related
Categories
Questions about Audit Document
What does Audit Document do?
通用文档审查维度 DA-1~DA-6 — README/架构文档/开发指南专属审查层. An agent skill from devcodex-labs/devcodex. Audit Document is an agent skill from devcodex-labs/devcodex.
When should I use Audit Document?
Audit Document fits situations like: tasks that involve Technical documentation.
How do I install Audit Document in Claude Code?
Run `npx skills add devcodex-labs/devcodex --skill audit-document -a claude-code`. Or copy the skill folder (content/skills/audit-document in devcodex-labs/devcodex) into .claude/skills/audit-document in your project. Claude Code loads it when a task matches its description.
How do I install Audit Document in Codex?
Run `npx skills add devcodex-labs/devcodex --skill audit-document -a codex`. Or copy the skill folder (content/skills/audit-document in devcodex-labs/devcodex) into .agents/skills/audit-document in your project. Codex loads it when a task matches its description.
Can I use Audit Document in Cursor, Gemini CLI or GitHub Copilot?
Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add devcodex-labs/devcodex --skill audit-document -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/audit-document, .gemini/skills/audit-document, .github/skills/audit-document and .opencode/skills/audit-document in your project.
What does Audit Document need to run?
SKILL.md names no scripts, command-line tools or credentials: Audit Document is instructions for the agent only.
Does Audit Document access the network?
SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.
Is Audit Document safe to install?
Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.
What licence does Audit Document use?
Audit Document is published under the AGPL-3.0 licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.
How many tokens does Audit Document use?
About 863 tokens (SKILL.md is roughly 3.5k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.
What are the alternatives to Audit Document?
Skills that share tags, products or a category with Audit Document: Diagram Design (cathrynlavery/diagram-design, 45k stars), Simple English (moeru-ai/airi, 50k stars), Get API Docs with chub (andrewyng/context-hub, 14k stars) and Doc Sync (JetBrains/ideavim, 10k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.
Who maintains Audit Document?
devcodex-labs (a GitHub organization) maintains it in devcodex-labs/devcodex, which has 439 GitHub stars. The repository holds 70 skills in this directory. The repository was last updated on September 17, 2026.
Source: devcodex-labs/devcodex on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.