📘
WritingJavaScript

Audit Readme

by devcodex-labs

Audit Readme is a Writing skill for Claude Code, published by devcodex-labs in devcodex.

202 stars26 forkson devcodex-labs/devcodexAdded 2026/09/05+16% in starsRepository updated 2026/08/31
View source on GitHubDownload repo ZIP
ai-codingclaude-codecodexcoding-agentcursordeveloper-toolsgemini-cligithub-copilotgroklocal-firstworkflow-runtime
Install in seconds
Install Audit Readme
Copy Audit Readme into your Claude Code skills folder. Run the command in your terminal, or review the source on GitHub before installing.
terminal
npx degit https://github.com/devcodex-labs/devcodex/tree/main/content/skills/audit-readme ~/.claude/skills/audit-readme

Requires Node.js. Downloads this skill only — not the rest of the repository — into your Claude Code skills folder.

Without Node.js

git clone https://github.com/devcodex-labs/devcodex.git

Clones the whole repository, then copy the skill’s own directory into your skills folder yourself.

In this catalog

Source file
content/skills/audit-readme/SKILL.md in devcodex-labs/devcodex
Installs to
~/.claude/skills/audit-readme
Collection
One of 25 skills cataloged from this repository
Category
Writing — 1227 skills

What Audit Readme does

Audit Readme reviews README files for user paths, quick start steps, example realism, configuration and troubleshooting visibility, and consistency with other entry points. Use it when the README is the main user-facing entry for a project or tool.

Audit Readme is cataloged under Writing on DirSkills. Audit Readme comes from a repository tagged ai-coding, claude-code, codex, coding-agent and cursor.

Documentation

README

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 消费链一致性 🟡/🔴

核心检查维度

This is the opening of the README. Read the full README on GitHub.

Frequently asked about Audit Readme

  • What else does devcodex-labs publish alongside Audit Readme?

    Audit Readme is one of 25 skills that DirSkills catalogs from devcodex-labs/devcodex, the repository it ships in. Its siblings there include AI Agent System Architecture, AI Evaluation Engineering and API Contract Architecture. Each one is a separate skill with its own page in this directory, installs the same way Audit Readme does, and is maintained by devcodex-labs in that same repository. The rest of the collection is listed on the devcodex-labs/devcodex page.

  • How does Audit Readme compare to other Writing skills?

    Audit Readme ranks #994 by stars among the 1227 Writing skills in this catalog. The most-starred ones next to it are Article Writing, Social Media Content Calendar and Knowledge Comic Creator. DirSkills ranks by the star count of the repository each skill ships in, so that order reflects how popular those repositories are rather than any review of Audit Readme against them. Open each page to compare what they document and how they install.

More from devcodex-labs/devcodex

Audit Readme is one of 25 skills cataloged on DirSkills from devcodex-labs/devcodex.

See all 25 skills →
🤖
47m ago

AI Agent System Architecture

AI Agent System Architecture covers agent routing, tool permissions, context, memory, state, and observability for tasks that need explainable and auditable agent behavior. Use it when designing agent workflows, recovery, handoff, or model-assisted governance.
AI Engineering
20226
🧪
47m ago

AI Evaluation Engineering

AI Evaluation Engineering designs evidence for model and prompt quality using golden sets, rubrics, judge calibration, repeat sampling, variance reporting, and regression decisions. Use it when comparing models, prompts, or upgrades and you need reproducible results with contamination checks.
AI Engineering
20226
🧩
47m ago

API Contract Architecture

API Contract Architecture defines and freezes public API contracts before implementation. Use it for HTTP, SDK, CLI, schema, error, pagination, idempotency, and compatibility changes that affect consumers.
AI Engineering
20226
🌐
47m ago

Accessibility I18n

Accessibility I18n handles accessibility and localization review for user-facing UI, CLI output, and docs. Use it when tasks involve keyboard flow, focus, screen readers, ARIA, RTL, translations, locale formats, or multilingual content.
Frontend
20226
🔍
47m ago

Analyze Default

Analyze Default defines a read-only workflow for multi-round code analysis, evidence gathering, and convergence checks. Use it when you need a factual conclusion, root-cause assessment, or review of whether something is correct without changing files.
Quality
20226
🔬
47m ago

Analyze Research

Analyze Research handles technical selection, feasibility checks, dependency comparisons, and root-cause investigation in a read-only workflow. Use it when you need evidence-based recommendations without changing source files.
AI Engineering
20226

More Writing skills

Audit Readme is one of 1227 Writing skills cataloged on DirSkills, ranked #994 by stars among them.

Browse all Writing skills →
✍️
3w ago

Article Writing

Article Writing writes articles, guides, blog posts, tutorials, newsletter issues, and other long-form content in a distinctive voice derived from supplied examples or brand guidance. Use it when you want polished written content longer than a paragraph, especially when voice consistency, structure, and credibility matter.
Writing
239.8K36.4K
📅
3w ago

Social Media Content Calendar

Social Media Content Calendar plans multi-platform social campaigns from briefs through scheduling and verified publishing. Use it when building a calendar, turning launches into posts, or repurposing content across X, LinkedIn, Instagram, and TikTok.
Writing
229.7K45.3K
🎨
3w ago

Knowledge Comic Creator

Knowledge Comic Creator generates educational, biography, and tutorial comics from user-provided text, URLs, or topics, with configurable art styles, tones, layouts, and languages. Use it when a user asks for a knowledge comic, 知识漫画, or Logicomix-style explanation.
Writing
229.7K45.3K