docs-audit SKILL.md skillA

docs-audit from stark-ai-de/agent-skills is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.

Install it, pinned
mdr add stark-ai-de/agent-skills/docs-audit@v0.1.0

Pins v0.1.0 in mdr.lock. Pin the fingerprint instead.

Audit grade
A, 17 of 17 checks passed
Kind
SKILL.md skill
Repository
stark-ai-de/agent-skills
Path
incubator/skills/repo-maintenance/docs-audit/SKILL.md
Versions recorded
1
Latest version
v0.1.0, committed May 21, 2026
Size
2,791 bytes
Repository stars
8
License
Apache-2.0

Audit repository documentation, README, examples, installation steps, onboarding flow, API docs, and contribution docs. Use when the user asks whether docs are clear, complete, current, or ready for a public repo.

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

## Goal

Find documentation gaps that block users, contributors, maintainers, or agents from understanding, installing, validating, and safely changing the repository.

## When to use

- The user asks whether docs are clear, complete, current, or public-ready.
- README, examples, onboarding, API docs, or contribution docs need review.
- Documentation promises may have drifted from actual code and commands.

## When not to use

- The user asks for a full repo maintenance audit; use `repo-health-audit`.
- The user wants release notes; use `release-manager`.
- The user wants prose editing only and no repo evidence check.

## Inputs to inspect

- README, docs, examples, changelog, contributing guide, security policy, and license.
- Package scripts, CLI help, config examples, and source files that docs mention.
- Internal links, install commands, screenshots, and generated docs.

## Review rubric

Check audience fit, first-run path, command accuracy, link integrity, examples, maintenance docs, public safety, and agent usability. Read `references/docs-rubric.md` for details.

## Workflow

1. Identify the intended audiences and main user journeys.
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint
mdr add stark-ai-de/agent-skills/docs-audit@sha256:ab3edf0305b442ed

The line at the top of this page pins the label v0.1.0, 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_jx7w5isuzp4zq345.svg)](https://markdownregistry.com/a/art_jx7w5isuzp4zq345)

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

Versions

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

versioncommittedcommitsizeaudit
v0.1.0 latest2026-05-21 feebcf2 2,791 BA view

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

stark-ai-de/agent-skills · 8 stars · license Apache-2.0 · pushed 2026-10-20 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_jx7w5isuzp4zq345
GET https://markdownregistry.com/api/v1/resolve?ref=stark-ai-de/agent-skills/docs-audit
GET https://markdownregistry.com/api/v1/blob/ab3edf0305b442ed1c2984854e365542df3355a092f6768b7878328399d48b16

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 stark-ai-de/agent-skills

AGENTS.md AGENTS.md file
stark-ai-de/agent-skills · AGENTS.md
git:20261016.b17a98e · audit A · 8 stars
codex-context-guard SKILL.md skill
stark-ai-de/agent-skills · incubator/skills/codex-operations/codex-context-guard/SKILL.md · Prevent Codex context-window exhaustion during long-running refactors, repo audits, migrations, debugging sessions, or…
v0.1.0 · audit A · 8 stars
change-impact SKILL.md skill
stark-ai-de/agent-skills · incubator/skills/engineering-workflows/change-impact/SKILL.md · Find forgotten follow-up changes outside a behavior-changing diff in tests, examples, documentation, configuration, and…
v0.2.0 · audit A · 8 stars
debugging-diagnosis SKILL.md skill
stark-ai-de/agent-skills · incubator/skills/engineering-workflows/debugging-diagnosis/SKILL.md · Diagnose and fix bugs through reproduction, minimization, hypotheses, instrumentation, targeted fixes, and regression…
v0.1.0 · audit A · 8 stars
issue-plan-slicer SKILL.md skill
stark-ai-de/agent-skills · incubator/skills/engineering-workflows/issue-plan-slicer/SKILL.md · Convert a spec, roadmap item, or rough plan into independently implementable issue slices with scope, dependencies…
v0.1.0 · audit A · 8 stars
prd-writer SKILL.md skill
stark-ai-de/agent-skills · incubator/skills/engineering-workflows/prd-writer/SKILL.md · Write a concise PRD or implementation brief from current context, separating problem, solution, user stories…
v0.1.0 · audit A · 8 stars
prototype-spike SKILL.md skill
stark-ai-de/agent-skills · incubator/skills/engineering-workflows/prototype-spike/SKILL.md · Build or plan an explicitly throwaway prototype to answer a design, API, UX, performance, or integration question, then…
v0.1.0 · audit A · 8 stars
repo-map-zoom-out SKILL.md skill
stark-ai-de/agent-skills · incubator/skills/engineering-workflows/repo-map-zoom-out/SKILL.md · Map unfamiliar code areas before implementation by identifying entry points, ownership boundaries, callers, data flow…
v0.1.0 · audit A · 8 stars
review-fix-swarm SKILL.md skill
stark-ai-de/agent-skills · incubator/skills/engineering-workflows/review-fix-swarm/SKILL.md · Run a bounded post-implementation multi-agent review, bug-fix, behavior-preserving simplification, and re-review loop…
v0.1.0 · audit A · 8 stars
test-first-implementation SKILL.md skill
stark-ai-de/agent-skills · incubator/skills/engineering-workflows/test-first-implementation/SKILL.md · Implement behavior with a red-green-refactor loop, observable tests, and small vertical slices. Use when the user asks…
v0.1.0 · audit A · 8 stars
grill-plan SKILL.md skill
stark-ai-de/agent-skills · incubator/skills/productivity/grill-plan/SKILL.md · Relentlessly question a plan, design, migration, release, or repo maintenance proposal until assumptions, risks…
v0.1.0 · audit A · 8 stars
handoff SKILL.md skill
stark-ai-de/agent-skills · incubator/skills/productivity/handoff/SKILL.md · Write a compact handoff document so a fresh agent, thread, or session can continue. Use when context is long, the user…
v0.1.1 · audit A · 8 stars

Every file in stark-ai-de/agent-skills

Other files named docs-audit

docs-audit SKILL.md skill
qshanx/docs-governance · skills/documentation/docs-audit/SKILL.md · 只读审计现有项目文档,检查资料散乱、入口难找、断链、内容过时、重复主源及当前与历史混用。用于用户要求“审计文档”“检查文档是否过时”“看看文档哪里乱”,或阶段交接前检查文档体系时。
git:20261012.bd30f6e · audit A · 218 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 · 14 stars

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