documentation-testing

documentation-testing is a skill for Claude Code, Codex from jimmc414/claude-code-plugin-marketplace. It costs 0 tokens per session (1,321 once invoked), scanned A, original, MIT.

A checklist and set of tests for finding incomplete, outdated, or broken developer documentation, such as README setup instructions.

In plain words
What is it for?
Use it to test onboarding, review documentation, check setup guides, and find undocumented tools or environment variables.
Why use it?
It identifies missing prerequisites and configuration details that can make installing or starting a project difficult.

Skill for Claude CodeCodex

Part of the doc-linter plugin — 1 skill, 1 agent shipped together

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add skills/jimmc414/claude-code-plugin-marketplace/documentation-testing
Any agent
npx skills add jimmc414/claude-code-plugin-marketplace --skill documentation-testing
Clone the repo
git clone --depth 1 https://github.com/jimmc414/claude-code-plugin-marketplace

Made for: Claude Code, Codex.

Or install doc-linter, the plugin that ships this one along with the rest of its 1 skill, 1 agent.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for documentation-testing

README.md
[![agentmods](https://agentmods.dev/badge/skills/jimmc414/claude-code-plugin-marketplace/documentation-testing.svg)](https://agentmods.dev/skills/jimmc414/claude-code-plugin-marketplace/documentation-testing)
Your own site
<a href="https://agentmods.dev/skills/jimmc414/claude-code-plugin-marketplace/documentation-testing"><img src="https://agentmods.dev/badge/skills/jimmc414/claude-code-plugin-marketplace/documentation-testing.svg" alt="Measured on agentmods" height="20"></a>
Per session 0 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 1,321 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 1 finding. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00000 $0.01321
Opus 5 $0.00000 $0.00660
Sonnet 5 $0.00000 $0.00264
Haiku 4.5 $0.00000 $0.00132

Measured 4d ago against content hash e2a36d5499e8, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

documentation-testing scanned grade A with 1 finding against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 4d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Asks for rootlowPrivilege escalation

A mod that escalates privileges can change anything on the machine, not only the project.

| **Permissions** | File/directory permissions, sudo requirements |

Downgraded: this mod is about security review, or the phrase is quoted, so it is likely naming the pattern rather than instructing it.

plugins/doc-linter/skills/documentation-testing/SKILL.md · 175 lines

How it starts

The opening of the file, as written. The whole thing — 175 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Documentation Testing Skill

Purpose

Provides systematic heuristics for identifying incomplete, outdated, or broken documentation. This skill helps catch the gaps that make onboarding painful for new developers.

Common Documentation Failures

Missing Prerequisites

Projects often assume these are installed without documenting them:

Category Examples
JavaScript Node.js, npm, yarn, pnpm (and which version)
Python Python, pip, poetry, conda (and which version)
Containers Docker, docker-compose, podman
Databases PostgreSQL, MySQL, Redis, MongoDB, SQLite
Cloud CLIs aws, gcloud, az, terraform
Build tools make, cmake, gcc, clang
Version managers nvm, pyenv, rbenv, asdf

Missing Environment Configuration

Look for these patterns that indicate undocumented environment variables:

Language Pattern to detect
JavaScript/TypeScript process.env.XXX
Python os.environ["XXX"] or os.getenv("XXX")
Ruby ENV["XXX"]
Go os.Getenv("XXX")
Rust std::env::var("XXX")

Red flags:

  • References to .env files without .env.example
  • config.yaml with placeholder values but no instructions
  • Environment variables mentioned in code but not in README

Incomplete Setup Steps

Common missing steps that break new developer onboarding:

Step What's often missing
Database setup createdb, migrations, seed data
Service dependencies Starting Redis, Postgres, etc. before the app
SSL/TLS Local HTTPS setup, certificate generation
Host files /etc/hosts modifications for local domains
Ports Required ports and how to check if they're in use
Permissions File/directory permissions, sudo requirements
Git hooks Pre-commit hooks that need manual setup
IDE setup Extensions, settings, debug configurations

Read the full file on GitHub · 175 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 4d ago First seen · 175 lines · 0 tokens per session scan A e2a36d5499e8

Subscribe to this mod's changes

documentation-testing is a skill published in the GitHub repository jimmc414/claude-code-plugin-marketplace (4 stars, last pushed today), licensed MIT. It costs nothing until one of its globs matches a file; then it loads 1,321 tokens. A static security scan graded it A with 1 finding (asks for root). No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.

Related

Other skills, from other repositories

phpunit-migration-test-reviewing

Internal sub-skill. Do not auto-activate. Use only when explicitly invoked by name by another skill or agent.

shopwareLabs/ai-coding-tools · 32 tokens

phpunit-unit-test-reviewing

Internal sub-skill. Do not auto-activate. Use only when explicitly invoked by name by another skill or agent.

shopwareLabs/ai-coding-tools · 31 tokens

structuring-documentation

Use when writing, editing, auditing, splitting, or measuring Markdown documentation surfaces — README.md, AGENTS.md, CLAUDE.md, and docs/ siblings. Triggers include "is this doc too long", "split this README", "measure the docs", "where does this documentation belong", "audit the documentation", and any request to…

shopwareLabs/ai-coding-tools · 89 tokens

phpunit-integration-test-generation

Use this skill when the user asks to generate, write, or create integration tests for a Shopware 6 source class whose contract requires wired-up code — phrases like "generate integration tests for X", "write an integration test for this controller", "test this indexer", "create an integration test for the message…

shopwareLabs/ai-coding-tools · 184 tokens

phpunit-unit-test-generation

Internal sub-skill. Do not auto-activate. Use only when explicitly invoked by name by another skill or agent.

shopwareLabs/ai-coding-tools · 30 tokens

phpunit-unit-test-writing

Use this skill when the user asks to write, generate, create, or add PHPUnit unit tests for a Shopware 6 source class — phrases like "write unit tests for X", "generate tests for ClassName", "create PHPUnit tests", "add test coverage", "test this class", "cover this with tests", "I need tests for", "unit test this"…

shopwareLabs/ai-coding-tools · 187 tokens