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.
README / 用户使用文档专项审查维度 RM-1~RM-6 — 聚焦用户路径、快速开始、示例真实度、配置排错与消费链一致性
Install Audit Readme
$ npx skills add devcodex-labs/devcodex --skill audit-readme -a claude-codeProject install by default; add -g for ~/.claude/skills/.
$ gh skill install devcodex-labs/devcodex audit-readme --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-readme .claude/skills/audit-readme && 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-readme" agent skill from https://github.com/devcodex-labs/devcodex/tree/main/content/skills/audit-readme into .claude/skills/audit-readme/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "audit-readme", 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-readmeType 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-readme -a codexProject install goes to .agents/skills/; add -g for ~/.codex/skills/.
$ gh skill install devcodex-labs/devcodex audit-readme --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-readme .agents/skills/audit-readme && 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-readme" agent skill from https://github.com/devcodex-labs/devcodex/tree/main/content/skills/audit-readme into .agents/skills/audit-readme/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "audit-readme", 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-readme -a cursorProject install goes to .agents/skills/; add -g for ~/.cursor/skills/.
$ gh skill install devcodex-labs/devcodex audit-readme --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-readme .cursor/skills/audit-readme && 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-readme" agent skill from https://github.com/devcodex-labs/devcodex/tree/main/content/skills/audit-readme into .cursor/skills/audit-readme/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "audit-readme", 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-readme--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-readme -a gemini-cliProject install goes to .agents/skills/; add -g for ~/.gemini/skills/.
$ gh skill install devcodex-labs/devcodex audit-readme --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-readme .gemini/skills/audit-readme && 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-readme" agent skill from https://github.com/devcodex-labs/devcodex/tree/main/content/skills/audit-readme into .gemini/skills/audit-readme/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "audit-readme", 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-readmeInstalls 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-readme -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-readme .github/skills/audit-readme && 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-readme" agent skill from https://github.com/devcodex-labs/devcodex/tree/main/content/skills/audit-readme into .github/skills/audit-readme/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "audit-readme", 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-readme -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-readme --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-readme .opencode/skills/audit-readme && 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-readme" agent skill from https://github.com/devcodex-labs/devcodex/tree/main/content/skills/audit-readme into .opencode/skills/audit-readme/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "audit-readme", 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-readme- GitHub stars
- 439
- Token cost
- ~1.3k tokens
- SKILL.md length
- 295 words
- Files
- 2
- Skills in repo
- 70
- Repo updated
- First seen
- Licence
- AGPL-3.0
At a glance
README / 用户使用文档专项审查维度 RM-1~RM-6 — 聚焦用户路径、快速开始、示例真实度、配置排错与消费链一致性
- Works in 9 steps: 用户能不能在 1 次阅读里完成第一次成功？ → 如果失败，文档有没有给出足够靠前的排错线索？ → 开发/贡献内容是否已经后置？ → …
- Tasks that involve Technical documentation
- SKILL.md covers 适用范围, 维度总览（RM-1~RM-6）, 核心检查维度 and 与 audit-document 的边界, plus 2 more sections
- Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md
What it does
Audit Readme is an agent skill from devcodex-labs/devcodex. README / 用户使用文档专项审查维度 RM-1~RM-6 — 聚焦用户路径、快速开始、示例真实度、配置排错与消费链一致性
Its SKILL.md is about 1.3k 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-readme”
Workflow steps
9 steps, taken from the first numbered list in SKILL.md.
- 用户能不能在 1 次阅读里完成第一次成功？
- 如果失败，文档有没有给出足够靠前的排错线索？
- 开发/贡献内容是否已经后置？
- README 与其他当前消费者是否一致？
- 性能、语法或能力矩阵是否避免内部术语优先，且说明了支持 / 不支持 / 优先级？
- 文档是否足够详细、心智负担足够低，首次读者能否看懂每个关键字段、命令、状态和失败恢复路径？
- 用户文档主面是否被开发契约替代？首页、quick start、nav/sidebar 和 CTA 是否仍优先回答“怎么使用”？
- 若存在文档站或生成站点，是否验证了实际生成产物、TOC/sidebar/nav 去重、真实用户路径和部署副本同步？
- README 是否区分生产推荐路径、fixture/mock/demo 边界和反模式，并给出框架原生能力或项目既有能力的专家级推荐？
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 Readme loads about 1.3k tokens when it runs. Until then it costs about 19 tokens; SKILL.md has 295 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). 295 words, ~1,251 tokens.
Download SKILL.mdSave it as
.claude/skills/audit-readme/SKILL.md (or your agent's skills folder). This skill also uses 1 other file; get the full folder from GitHub.- name
- audit-readme
- description
- README / 用户使用文档专项审查维度 RM-1~RM-6 — 聚焦用户路径、快速开始、示例真实度、配置排错与消费链一致性
Audit Readme Skill
适用范围
当审查目标是 README.md 或承担主使用入口职责的用户使用文档时，在 audit-document 的通用文档维度之上，叠加本 Skill。
若目标是站点文档、最终用户使用文档、最终用户手册、接入手册、公开能力页、项目文档设计或菜单导航审查，先使用 audit-user-manual 聚合 user-manual-authoring、audit-document、本 Skill、review-checklist、document-sync 与 test-router 的证据；落点为 README 或项目主文档时，再叠加本 Skill 的 RM-1~RM-6。
维度总览（RM-1~RM-6）
| 分组 | 维度 | 优先级 |
|---|---|---|
| A — 用户路径 | RM-1 用户路径完整性 · RM-2 快速开始可执行性 | 🔴 |
| B — 内容可信度 | RM-3 示例真实度 · RM-4 配置与排错可发现性 | 🔴/🟡 |
| C — 叙事与联动 | RM-5 开发信息后置性 · RM-6 消费链一致性 | 🟡/🔴 |
核心检查维度
RM-1 用户路径完整性 🔴
- 用户是否能快速知道“这是什么、适合谁、什么时候用”
- 文档是否给出从理解到第一次成功使用的完整路径
- 是否存在“只有能力说明，没有怎么开始”的断层
- 是否执行
UserPerspectiveDocsGate：从使用者真实任务出发组织，而不是按维护者内部实现、历史治理或仓库目录顺序堆叠 - 是否执行
UserDocsPrimarySurfaceGate：README、文档站或 quick start 的首页首屏、nav/sidebar 前两组、CTA、reference 入口是否先服务用户使用路径，而不是开发契约、目标 API、数据模型或实现验收 - 是否执行
FinalUserManualFirstGate：需求概况之后应先形成用户最终使用文档（文档站或至少 README），而不是先让开发文档、技术方案或实施计划占据主入口 - 是否执行
DocsSiteInformationArchitectureGate/UserManualFlowAndFailureGate：站点、README 或手册是否按真实用户任务、成功路径、失败恢复、限制和下一步组织，而不是把所有章节平铺给用户自己猜 - 是否执行
UserManualProductizationGate：README / quick start / 用户手册是否按最终使用者产品化组织受众、任务、配置、真实示例、排错、失败恢复和源码 / 示例可点击链路，内部字段和实现说明是否后置 - 多页文档站或 README 入口是否执行
DocsPageRoleMatrixGate/CompleteUserManualSiteMatrixGate，标明每页 role、audience、sourceOfTruth、nav/sidebar 位置和用户主路径状态
RM-2 快速开始可执行性 🔴
- 安装、启动、接入或运行步骤是否真实、完整、可执行
- 示例命令是否缺关键前置条件、环境变量、端口或依赖
- 最短成功路径是否足够短，避免把维护流程误当快速开始
- 用户第一次照着做时，是否能少跳转、少猜测、少补前置知识
- 快速开始含 Mermaid / 流程图 / 队列 / 异步 / 批处理示例时，是否执行
UserManualRenderedFlowAndRealWorkflowProbe，验证真实渲染并使用真实业务工作流 - 快速开始、fixture、mock 或 demo 是否执行
ExpertOutputQualityGate，先说明生产推荐路径、框架原生能力和真实接入方式，再标明样例的验证边界
RM-3 示例真实度 🟡
- 示例是否代表真实常见用法，而不是理想化伪代码
- 示例命名、参数、返回值是否与当前实现一致
- 示例是否帮助用户完成“第一次成功”
- 是否执行
DocsExampleTruthSurfaceGate：README / quick start 中的 option、config、method、field、导入路径或 CLI 参数必须能在 public types、runtime wiring、配置 schema、导出入口或最小执行探针里找到证据 - 是否执行
CallbackExampleScopeProbe：callback / hook / event / transaction / handler / ctx 示例的参数签名、ctx 字段、闭包变量、返回值和异常语义是否匹配当前实现 - 是否执行
ExpertOutputQualityGate：示例是否体现资深技术视角，明确区分推荐实践、框架已有能力、测试 fixture/mock/demo 边界和反模式；不得把硬编码单例、每个 route 重复声明或仅证明底层能力存在的夹具当成用户主路径 - 性能表、语法/能力矩阵是否先给用户选择结论，再解释字段含义、支持形式、不支持形式和优先级示例
- 参数、配置、模式、状态、错误码和限制是否逐项解释到“普通使用者能看懂并知道怎么选”
- 队列、任务、异步或批处理类 README 是否执行
QueueDocsRealWorkflowGate：给出真实入队、执行、状态查询、失败重试、清理和常见失败恢复，而不是只展示单条硬编码样例
RM-4 配置与排错可发现性 🟡
- 用户最常遇到的配置点是否能被找到
- FAQ、报错、依赖缺失、权限、端口、登录态等排错信息是否易发现
- 是否存在“问题在文档里，但埋得太深”
- 是否执行
UserDocsImmediateComprehensionGate：配置字段、默认值、选择建议、错误与排错是否简单易懂，并能让首次读者立即判断当前能做什么、不能做什么、怎么第一次成功
RM-5 开发信息后置性 🟡
- 开发方式、贡献流程、协作规范是否没有抢占主叙事
- README 是否优先服务使用者，而不是维护者
- 是否执行
PublicUserDocsMaintainerBoundaryGate：发布 checklist、维护者验收、内部同步清单、台账状态或复审任务不得作为公开 README / 用户文档的主路径 - 是否执行
SideEffectCompatibilityDocsGate：README / 快速上手不得把带全局副作用、兼容 shim、弃用行为或高心智负担的旧路径放入用户主路径 - 是否执行
ExecutableExampleTruthProbeGate：README 中 DSL、配置、模板或扩展示例需有当前实现的最小执行证据；未来语法必须标注 preview / unreleased - 若同时面向用户与贡献者，是否保持单一主叙事中心
RM-6 消费链一致性 🔴
- README 与
package.json、CLI、website、examples、Profile、changelog 是否一致 - 版本号、命令、路径、配置项、能力声明是否同步
- 是否出现“README 说能做，其他入口说法不同”的漂移
- README 中“已支持 / 已接入 / 已验证 / 可运行”类声明是否有
CodeTruthRequirementGate与LiveVerificationExecutionObligation证据 - README、comparison、scenario、index 或 generated search 发生行为语义变化时，是否执行
BehaviorSemanticDocsParityGate，用同义/历史术语矩阵反查 public API、runtime wiring、文档索引和生成搜索 - 多语言 README 或双语入口的支持/不支持、启用/禁用、同步/异步、缓存/刷新等负向语义是否执行
NegativeTranslationParityProbe - README 若存在翻译页或 website 双入口，是否执行
DocumentationTranslationParityGuard并保持信息等价 - README 是否遵守
FormalDocsDevCodexBoundary，没有混入运行时报告、台账、内部待办或一次性复盘口吻 - README 是否执行
DocsConsumerSweep：新增命令、字段、配置、导航顺序或能力声明后，website、Profile、examples、templates、validate probes 和代码消费点是否同步 - README 或文档站首页、quick start、公共用户路径变化时，是否执行
UserPathContractSweep，确认 README / website / nav/sidebar / examples / templates / validate probes / 部署副本与代码消费点同步 - 文档站主题、导航、搜索、代码高亮、移动端、暗色/亮色变化时，是否执行
DocsThemeRuntimeVisualProbeGate，基于真实运行态验证视觉和交互
与 audit-document 的边界
| 维度层 | 负责内容 |
|---|---|
audit-document | 通用结构、准确性、链接、术语、受众适配、关联一致性 |
audit-readme | 用户路径、快速开始、示例真实度、开发信息后置、消费链一致性 |
规则：
- 通用文档问题优先记在
DA-* - README 专项问题记在
RM-* - 不重复用两套维度描述同一个 finding
输出建议
审查 README 时，建议至少回答以下问题：
- 用户能不能在 1 次阅读里完成第一次成功？
- 如果失败，文档有没有给出足够靠前的排错线索？
- 开发/贡献内容是否已经后置？
- README 与其他当前消费者是否一致？
- 性能、语法或能力矩阵是否避免内部术语优先，且说明了支持 / 不支持 / 优先级？
- 文档是否足够详细、心智负担足够低，首次读者能否看懂每个关键字段、命令、状态和失败恢复路径？
- 用户文档主面是否被开发契约替代？首页、quick start、nav/sidebar 和 CTA 是否仍优先回答“怎么使用”？
- 若存在文档站或生成站点，是否验证了实际生成产物、TOC/sidebar/nav 去重、真实用户路径和部署副本同步？
- README 是否区分生产推荐路径、fixture/mock/demo 边界和反模式，并给出框架原生能力或项目既有能力的专家级推荐？
N/A 规则
- 纯内部占位 README、明确只做跳转门户页：RM-2 / RM-3 可按实际场景标注 N/A，但必须明确真实用户文档入口。
- 非 README 的架构文档、治理说明、贡献指南：本 Skill 不触发。
- 站点文档、最终用户手册、接入手册、项目文档设计或菜单导航但非 README：优先审查
audit-user-manual+audit-document，本 Skill 只在其承担 README / 主入口职责时叠加。
© 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-readme of devcodex-labs/devcodex.
- SKILL.md
- intent.json
Open the folder on GitHubat commit 1dd4525
Compare with similar skills
Audit Readme 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 Readme this skilldevcodex-labs/devcodex | 439 | — | ~1.3k | Automated safety check: Pass | AGPL-3.0 | |
| Diagram Designcathrynlavery/diagram-design | 44k | 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.4k | 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 Readme
What does Audit Readme do?
README / 用户使用文档专项审查维度 RM-1~RM-6 — 聚焦用户路径、快速开始、示例真实度、配置排错与消费链一致性. Audit Readme is an agent skill from devcodex-labs/devcodex.
When should I use Audit Readme?
Audit Readme fits situations like: tasks that involve Technical documentation.
How do I install Audit Readme in Claude Code?
Run `npx skills add devcodex-labs/devcodex --skill audit-readme -a claude-code`. Or copy the skill folder (content/skills/audit-readme in devcodex-labs/devcodex) into .claude/skills/audit-readme in your project. Claude Code loads it when a task matches its description.
How do I install Audit Readme in Codex?
Run `npx skills add devcodex-labs/devcodex --skill audit-readme -a codex`. Or copy the skill folder (content/skills/audit-readme in devcodex-labs/devcodex) into .agents/skills/audit-readme in your project. Codex loads it when a task matches its description.
Can I use Audit Readme 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-readme -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-readme, .gemini/skills/audit-readme, .github/skills/audit-readme and .opencode/skills/audit-readme in your project.
What does Audit Readme need to run?
SKILL.md names no scripts, command-line tools or credentials: Audit Readme is instructions for the agent only.
Does Audit Readme 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 Readme 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 Readme use?
Audit Readme 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 Readme use?
About 1.3k tokens (SKILL.md is roughly 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 Readme?
Skills that share tags, products or a category with Audit Readme: Diagram Design (cathrynlavery/diagram-design, 44k 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 Readme?
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.