documentation-audit SKILL.md skillA

documentation-audit from karsten-s-nielsen/mad-scientist-skills is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.

Install it, pinned
mdr add karsten-s-nielsen/mad-scientist-skills/documentation-audit@git:20260926.35dafdd

Pins git:20260926.35dafdd in mdr.lock. Pin the fingerprint instead.

Audit grade
A, 17 of 17 checks passed
Kind
SKILL.md skill
Repository
karsten-s-nielsen/mad-scientist-skills
Path
plugins/mad-scientist-skills/skills/documentation-audit/SKILL.md
Versions recorded
4
Latest version
git:20260926.35dafdd, committed Sep 26, 2026
First version recorded
Mar 28, 2026
Size
68,649 bytes
Repository stars
3
License
MIT

Comprehensive documentation audit with two modes and a single tier. Planning mode designs documentation strategy, content type maps, learning paths, and scaffolding architecture. Audit mode evaluates linguistic precision (Strunk & White, Google/Microsoft style guides), structural taxonomy (Diataxis quadrant classification, Good Docs Project), pedagogical scaffolding (Carroll's Minimalism, Cognitive Load Theory, Merrill's First Principles, Lemov techniques), cross-document consistency…

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

# Documentation Audit

A comprehensive documentation audit with two modes and a single tier:

**Modes:**
- **Planning** (before docs exist) — documentation strategy design, content type mapping, learning path architecture, scaffolding strategy
- **Audit** (on existing docs) — linguistic precision, structural taxonomy, pedagogical effectiveness, consistency, repository architecture, audience calibration, completeness and freshness

**Single tier:** Unlike security auditing, documentation evaluation is methodology-based (style guide application, framework classification, cognitive load analysis), not tool-licensed. Vale, markdownlint, and the analytical frameworks are all free/open-source. The value is in the analytical framework, not the scanner.

**Core question:** "Does this documentation teach effectively?"

## Academic foundations

This skill synthesizes seven research threads into a single audit methodology:

1. **Classical Composition** (Strunk & White 1918/1959) — Omit needless words, active voice, positive form, specific/concrete language, parallel construction. The foundational linguistic layer beneath all documentation quality.
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint
mdr add karsten-s-nielsen/mad-scientist-skills/documentation-audit@sha256:683957de26f6cfb4

The line at the top of this page pins the label git:20260926.35dafdd, 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_6ojgydo7xalmflwm.svg)](https://markdownregistry.com/a/art_6ojgydo7xalmflwm)

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

Versions

The registry has recorded 4 versions of this file, between Mar 28, 2026 and Sep 26, 2026, about one every 61 days.

versioncommittedcommitsizeaudit
git:20260926.35dafdd latest2026-09-26 35dafdd 68,649 BA view · diff
git:20260408.03243482026-04-08 0324348 68,636 BA view · diff
git:20260329.f91268f2026-03-29 f91268f 66,578 BA view · diff
git:20260328.6497f492026-03-28 6497f49 66,439 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 (68649 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

karsten-s-nielsen/mad-scientist-skills · 3 stars · license MIT · pushed 2026-10-01 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_6ojgydo7xalmflwm
GET https://markdownregistry.com/api/v1/resolve?ref=karsten-s-nielsen/mad-scientist-skills/documentation-audit
GET https://markdownregistry.com/api/v1/blob/683957de26f6cfb42c189819929ddd75f9d63530f6481806f5a602ce5b82ec1a

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 karsten-s-nielsen/mad-scientist-skills

AGENTS.md AGENTS.md file
karsten-s-nielsen/mad-scientist-skills · AGENTS.md
git:20260926.35dafdd · audit A · 3 stars
CLAUDE.md CLAUDE.md file
karsten-s-nielsen/mad-scientist-skills · CLAUDE.md
git:20260926.35dafdd · audit B · 3 stars
architecture-audit SKILL.md skill
karsten-s-nielsen/mad-scientist-skills · plugins/mad-scientist-skills/skills/architecture-audit/SKILL.md · Comprehensive architecture audit with two modes and a single tier (beta). Planning mode evaluates architectural…
git:20260926.35dafdd · audit A · 3 stars
c4 SKILL.md skill
karsten-s-nielsen/mad-scientist-skills · plugins/mad-scientist-skills/skills/c4/SKILL.md · Creates interactive C4 model architecture diagrams using Structurizr DSL — the official C4 notation by Simon Brown…
git:20260813.1e1da60 · audit B · 3 stars
cognitive-interface-audit SKILL.md skill
karsten-s-nielsen/mad-scientist-skills · plugins/mad-scientist-skills/skills/cognitive-interface-audit/SKILL.md · Comprehensive cognitive interface audit with two modes and a single tier. Planning mode designs task models, user…
git:20260926.35dafdd · audit A · 3 stars
final-review SKILL.md skill
karsten-s-nielsen/mad-scientist-skills · plugins/mad-scientist-skills/skills/final-review/SKILL.md · Pre-commit quality gate — reviews all code and documentation for consistency, best practices, and completeness, then…
git:20260929.7b74d3a · audit A · 3 stars
measure-before-optimize SKILL.md skill
karsten-s-nielsen/mad-scientist-skills · plugins/mad-scientist-skills/skills/measure-before-optimize/SKILL.md · Pre-change measurement gate for perf-sensitive functions. Use BEFORE modifying any function that has a pytest-benchmark…
git:20260929.7b74d3a · audit A · 3 stars
observability-audit SKILL.md skill
karsten-s-nielsen/mad-scientist-skills · plugins/mad-scientist-skills/skills/observability-audit/SKILL.md · Comprehensive observability audit with two modes and two tiers (beta). Planning mode designs telemetry strategy…
git:20260416.d18ed8c · audit A · 3 stars
optimization-audit SKILL.md skill
karsten-s-nielsen/mad-scientist-skills · plugins/mad-scientist-skills/skills/optimization-audit/SKILL.md · Comprehensive optimization audit with two modes and a single tier. Planning mode designs performance strategy, capacity…
git:20260929.7b74d3a · audit B · 3 stars
research-discipline SKILL.md skill
karsten-s-nielsen/mad-scientist-skills · plugins/mad-scientist-skills/skills/research-discipline/SKILL.md · Use when designing or validating a quantitative metric, model, or ranking, when pre-registering an analysis, or before…
git:20261001.d0fd4dd · audit A · 3 stars
security-audit SKILL.md skill
karsten-s-nielsen/mad-scientist-skills · plugins/mad-scientist-skills/skills/security-audit/SKILL.md · Comprehensive security audit with two modes and two tiers. Planning mode reviews architecture for security gaps (STRIDE…
git:20260724.35d8a81 · audit B · 3 stars
unbiased-review SKILL.md skill
karsten-s-nielsen/mad-scientist-skills · plugins/mad-scientist-skills/skills/unbiased-review/SKILL.md · Use when reviewing a spec, plan, or implementation produced by another session - verifies its claims against the actual…
git:20260929.7b74d3a · audit A · 3 stars

Every file in karsten-s-nielsen/mad-scientist-skills

Other files named documentation-audit

documentation-audit SKILL.md skill
aiskillstore/marketplace · skills/2389-research/documentation-audit/SKILL.md · This skill should be used when verifying documentation claims against codebase reality. Triggers on "audit docs"…
git:20260113.222b7de · audit A · 439 stars
documentation-audit SKILL.md skill
int2t05/engineering-skills · skills/09-operate/documentation-audit/SKILL.md · Write or synchronize implementation documentation with source evidence. Triggers on "docs out of date", "文档同步".
git:20261015.f440cbb · audit A · 3 stars

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