docs-audit SKILL.md skillA

docs-audit from me2resh/apexyard is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.

Install it, pinned
mdr add me2resh/apexyard/docs-audit@git:20260524.44f7e7a

Pins git:20260524.44f7e7a in mdr.lock. Pin the fingerprint instead.

Audit grade
A, 17 of 17 checks passed
Kind
SKILL.md skill
Repository
me2resh/apexyard
Path
marketplace/audit-pack/.claude/skills/docs-audit/SKILL.md
Versions recorded
1
Latest version
git:20260524.44f7e7a, committed May 24, 2026
Size
6,263 bytes
Repository stars
551
License
MIT

Diataxis docs audit — tutorials, how-to, reference, explanation; checks README, API docs, deployment guides, changelog, staleness.

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

# /docs-audit — Documentation Completeness (Diataxis)

Deep-dive documentation analysis using the Diataxis framework. Checks that docs cover all four quadrants (tutorials, how-to guides, reference, explanation) and are not stale. Invoke when `/launch-check`'s documentation row shows WARN or FAIL.

## Diataxis Framework

| Quadrant | Purpose | What to look for |
|----------|---------|-----------------|
| **Tutorials** | Learning-oriented, guided first steps | Getting started guide, quickstart, "Hello World" |
| **How-to guides** | Goal-oriented, solving specific problems | Deployment guide, migration guide, troubleshooting |
| **Reference** | Information-oriented, accurate description | API docs, config reference, CLI flags, environment variables |
| **Explanation** | Understanding-oriented, why things work | Architecture overview, design decisions (AgDRs), ADRs |

## Process

### Step 1: README quality

Check `README.md` for these sections (each is pass/fail):

| Section | Present? | Quality check |
|---------|----------|--------------|
| Project description | | One paragraph explaining what this is and who it's for |
…

Read the whole file at its exact version.

How to install

No tool to install first
claude plugin marketplace add https://markdownregistry.com/mp/a/art_jujbqhkz2t4g45w5/9fbadfcf366dc77bf3e209a5c91da7e231f9e88a83512dc8ebe1bc9fd1e5059e.json

Then /plugin install docs-audit@markdownregistry-jujbqhkz2t4g45w5 in Claude Code. It installs git:20260524.44f7e7a, the one graded A here, pinned to the commit it was graded at, and leaves it there.

The exact contents, by fingerprint
mdr add me2resh/apexyard/docs-audit@sha256:9fbadfcf366dc77b

The line at the top of this page pins the label git:20260524.44f7e7a, 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_jujbqhkz2t4g45w5.svg)](https://markdownregistry.com/a/art_jujbqhkz2t4g45w5)

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

Ask from your agent
claude mcp add --transport http markdownregistry https://markdownregistry.com/mcp/registry

Then ask it: what changed in me2resh/apexyard/docs-audit since the version I have? It reads every saved version here, no key and no account. Any agent that speaks MCP can add it.

Got a copy of docs-audit from somewhere else? Ask it: where did my docs-audit come from, and what was changed? It names the public original, the version yours is closest to and every changed line. The text is not kept.

Versions

The registry has recorded 1 version of this file, committed on May 24, 2026.

Watch this file (sign in, one email per new version)

versioncommittedcommitsizeaudit
git:20260524.44f7e7a latest2026-05-24 44f7e7a 6,263 BA view
Keep it current by itself, install once

Committed this skill to a repository? Install the markdownregistry skill updates app on it, or on all of them. When the registry saves a newer version, a pull request brings your copy to it within minutes, the newest version first, then what changed and any check it newly trips. A copy you edited is never touched, and nothing is deleted.

Install on GitHub

It asks to read and write contents and pull requests, and to read metadata. No workflow file, no Actions setting, nothing runs on your runners. Uninstall it and everything the registry kept about your repository is deleted.

Keep it current by itself

Committed this skill to a repository? Add one workflow file, and when a newer version is saved, a pull request brings your copy to it, the newest version first, then what changed and any check it newly trips. A copy you edited is never touched, and nothing is deleted.

mkdir -p .github/workflows && curl -fsSL https://markdownregistry.com/ci/skill-updates.yml -o .github/workflows/skill-updates.yml

It runs daily on GitHub Actions, no key and no account. Read the workflow before you add it.

Check a whole project

From the root of your project, one line hashes each installed skill's SKILL.md, your AGENTS.md and your CLAUDE.md, and asks the registry once. Only the fingerprints and paths are sent.

sha256sum .claude/skills/*/SKILL.md AGENTS.md CLAUDE.md | curl -s --data-binary @- https://markdownregistry.com/api/v1/check-copies

In CI, add --fail-with-body: the answer is 409 when any file is behind, so the step fails and still prints which files.

sha256sum .claude/skills/*/SKILL.md AGENTS.md CLAUDE.md | curl -s --fail-with-body --data-binary @- https://markdownregistry.com/api/v1/check-copies

No sha256sum on your machine? shasum -a 256 prints the same lines.

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 (6263 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

me2resh/apexyard · 551 stars · license MIT · pushed 2026-11-18 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_jujbqhkz2t4g45w5
GET https://markdownregistry.com/api/v1/resolve?ref=me2resh/apexyard/docs-audit
GET https://markdownregistry.com/api/v1/blob/9fbadfcf366dc77bf3e209a5c91da7e231f9e88a83512dc8ebe1bc9fd1e5059e

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 me2resh/apexyard

accessibility-audit SKILL.md skill
me2resh/apexyard · .claude/skills/accessibility-audit/SKILL.md · WCAG 2.2 AA audit — perceivable, operable, understandable, robust criteria. Deep-dive for /launch-check accessibility.
git:20261015.37f5689 · audit A · 551 stars
agdr SKILL.md skill
me2resh/apexyard · .claude/skills/agdr/SKILL.md · Browse / search / show / stats AgDRs across the portfolio — recalls "have we decided this before?".
git:20261015.37f5689 · audit A · 551 stars
analytics-audit SKILL.md skill
me2resh/apexyard · .claude/skills/analytics-audit/SKILL.md · Analytics audit — SDK config, event naming, funnel completeness, dashboards. Deep-dive for /launch-check analytics.
git:20261015.37f5689 · audit A · 551 stars
approve-architecture SKILL.md skill
me2resh/apexyard · .claude/skills/approve-architecture/SKILL.md · Record per-PR architecture-review approval for design-artifact PRs (required by the architecture gate). ONLY on an…
git:20261015.37f5689 · audit A · 551 stars
approve-design SKILL.md skill
me2resh/apexyard · .claude/skills/approve-design/SKILL.md · Record per-PR design-review approval (UI merge gate). ONLY on an explicit per-PR designer "approved".
git:20261015.37f5689 · audit A · 551 stars
approve-merge SKILL.md skill
me2resh/apexyard · .claude/skills/approve-merge/SKILL.md · Record per-PR CEO approval and merge in one turn. ONLY on an explicit per-PR "approved" — never on umbrella "go".
git:20261022.74bff5f · audit A · 551 stars
audit-deps SKILL.md skill
me2resh/apexyard · .claude/skills/audit-deps/SKILL.md · Audit dependencies for vulnerabilities, outdated packages, and license compliance.
git:20261022.74bff5f · audit A · 551 stars
bug SKILL.md skill
me2resh/apexyard · .claude/skills/bug/SKILL.md · Create a structured bug ticket (Given/When/Then scenario, repro steps, severity).
git:20261022.74bff5f · audit A · 551 stars
c4 SKILL.md skill
me2resh/apexyard · .claude/skills/c4/SKILL.md · Generate C4 L1 (Context) + L2 (Container) Mermaid diagrams from a project's codebase. Structurizr DSL escape hatch…
git:20261015.37f5689 · audit A · 551 stars
challenge SKILL.md skill
me2resh/apexyard · .claude/skills/challenge/SKILL.md · Invoke The Contrarian (Naqid) to steelman-then-challenge an idea, feature, decision, or plan — surfaces assumptions…
git:20261015.37f5689 · audit A · 551 stars
code-review SKILL.md skill
me2resh/apexyard · .claude/skills/code-review/SKILL.md · Review a PR for quality, security, and standards compliance. Invokes the Code Reviewer agent (Rex).
git:20261022.74bff5f · audit A · 551 stars
codify-rule SKILL.md skill
me2resh/apexyard · .claude/skills/codify-rule/SKILL.md · Turn a review comment that caught a Rex-miss into a draft handbook entry — Y/N gate, source-PR footer, bucket-routed.
git:20261015.37f5689 · audit A · 551 stars

Every file in me2resh/apexyard

Other files named docs-audit

docs-audit SKILL.md skill
me2resh/apexyard · .claude/skills/docs-audit/SKILL.md · Diataxis docs audit — tutorials, how-to, reference, explanation; checks README, API docs, deployment guides, changelog…
git:20261015.37f5689 · audit A · 551 stars
docs-audit SKILL.md skill
strands-agents/box · .agents/skills/docs-audit/SKILL.md · Assess an existing Box documentation page (docs/user/, docs/design/, or a crate README.md) for accuracy against the…
git:20261007.158dade · audit A · 548 stars
docs-audit SKILL.md skill
qshanx/docs-governance · skills/documentation/docs-audit/SKILL.md · 只读审计现有项目文档,检查资料散乱、入口难找、断链、内容过时、重复主源及当前与历史混用。用于用户要求“审计文档”“检查文档是否过时”“看看文档哪里乱”,或阶段交接前检查文档体系时。
git:20261012.bd30f6e · audit A · 326 stars
docs-audit SKILL.md skill
protolabsai/protoagent · plugins/technical_writer/skills/docs-audit/SKILL.md · Use when auditing docs section by section for stale claims, missing tasks, verbosity, complexity, redundancy, or…
git:20261018.f44fde5 · audit A · 19 stars
docs-audit SKILL.md skill
stark-ai-de/agent-skills · incubator/skills/repo-maintenance/docs-audit/SKILL.md · Audit repository documentation, README, examples, installation steps, onboarding flow, API docs, and contribution docs…
v0.1.0 · audit A · 8 stars

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