audit-readme SKILL.md skillA
audit-readme from devcodex-labs/devcodex is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add devcodex-labs/devcodex/audit-readme@git:20260730.6ee304aPins git:20260730.6ee304a 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-readme/SKILL.md- Versions recorded
- 1
- Latest version
- git:20260730.6ee304a, committed Jul 30, 2026
- Size
- 9,730 bytes
- Repository stars
- 432
- License
- AGPL-3.0
README / 用户使用文档专项审查维度 RM-1~RM-6 — 聚焦用户路径、快速开始、示例真实度、配置排错与消费链一致性.
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 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 或手册是否按真实用户任务、成功路径、失败恢复、限制和下一步组织，而不是把所有章节平铺给用户自己猜 …
Read the whole file at its exact version.
How to install
mdr add devcodex-labs/devcodex/audit-readme@sha256:01e8fbc3066a9609The line at the top of this page pins the label git:20260730.6ee304a, 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_5r6ykqt4kxu2ypuz)
4 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 1 version of this file, committed on Jul 30, 2026.
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 (9730 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
devcodex-labs/devcodex · 432 stars · license AGPL-3.0 · pushed 2026-10-27 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_5r6ykqt4kxu2ypuz GET https://markdownregistry.com/api/v1/resolve?ref=devcodex-labs/devcodex/audit-readme GET https://markdownregistry.com/api/v1/blob/01e8fbc3066a9609ca723de4f0c0219e44726840431adc8a71231804c409c66c
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.