documentation-standards

documentation-standards is a skill for Claude Code, Codex from MadAppGang/claude-code. It costs 34 tokens per session (5,868 once invoked), scanned A, original, MIT.

Use when writing README files, API documentation, user guides, or technical documentation following industry standards from Google, Microsoft, and GitLab style guides.

Skill for Claude CodeCodex

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/madappgang/claude-code/documentation-standards
Any agent
npx skills add MadAppGang/claude-code --skill documentation-standards
Clone the repo
git clone --depth 1 https://github.com/MadAppGang/claude-code

Made for: Claude Code, Codex.

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-standards

README.md
[![agentmods](https://agentmods.dev/badge/skills/madappgang/claude-code/documentation-standards.svg)](https://agentmods.dev/skills/madappgang/claude-code/documentation-standards)
Your own site
<a href="https://agentmods.dev/skills/madappgang/claude-code/documentation-standards"><img src="https://agentmods.dev/badge/skills/madappgang/claude-code/documentation-standards.svg" alt="Measured on agentmods" height="20"></a>
Per session 34 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 5,868 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 1 finding. Scan, not verified.
Origin unknown 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.00034 $0.05868
Opus 5 $0.00017 $0.02934
Sonnet 5 $0.00007 $0.01174
Haiku 4.5 $0.00003 $0.00587

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

Security

Grade A, and why

documentation-standards 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 today.

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.

Makes network callslowCapability

Not a fault in itself. Listed so you know the mod talks to something, and to what.

curl http://localhost:3000
plugins/dev/skills/documentation-standards/SKILL.md · 1,044 lines

How it starts

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

Documentation Standards

Overview

Comprehensive documentation standards based on research from Google, Microsoft, GitLab, Red Hat style guides, and 60+ additional sources. Provides templates, best practices, and anti-pattern detection for AI agents writing documentation.


15 Best Practices (Ranked by Consensus)

UNANIMOUS (100% Agreement)

1. Use Active Voice and Present Tense

Why: Reduces cognitive load 20-30%, shortens sentences 15-25%

Implementation:

BAD (passive): The request is processed by the server.
GOOD (active): The server processes the request.

BAD (future): The program will save your file.
GOOD (present): The program saves your file.

Validation: Check for "is/are/was/were + past participle" patterns


2. Start with 5-Minute Quick Start

Why: 70% of visitors are first-time users, time-to-first-success critical

Implementation:

## Quick Start

```bash
npm install my-tool
npx my-tool init
npx my-tool start

Visit http://localhost:3000

That's it!


**Validation**: Can a new user succeed in under 5 minutes with zero context?

---

#### 3. Use Progressive Disclosure (Three-Tier Structure)

**Why**: Accommodates all skill levels, reduces overwhelm

**Implementation**:

Tier 1: Quick Start (2-5 min) -> Copy-paste code, immediate success, no explanations

Tier 2: Tutorial (15-30 min) -> Step-by-step with explanations, build one feature

Tier 3: Reference (lookup) -> Complete API docs, searchable, advanced patterns


---

#### 4. Use Second Person ("You")

**Why**: Increases engagement, reduces word count 15-25%

**Implementation**:
```markdown
BAD: The user should configure the settings.
GOOD: Configure the settings.

BAD: One can install the plugin by...
GOOD: Install the plugin by...

5. Keep Sentences Under 25 Words

Why: Comprehension drops 30% when sentences exceed 30 words

Implementation:

BAD (42 words): The configuration file, which should be located in the
root directory of your project and named .claude, contains all the settings
that are required for the plugin system to function correctly and load
the appropriate agents.

GOOD (18 words): Place the `.claude` configuration file in your project
root. It contains settings for the plugin system and agents.

Read the full file on GitHub · 1,044 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. today First seen · 1,044 lines · 34 tokens per session scan A 4e3c5fb9ff57

Subscribe to this mod's changes

documentation-standards is a skill published in the GitHub repository MadAppGang/claude-code (279 stars, last pushed 5mo ago), licensed MIT. It adds 34 tokens to every session and 5,868 once invoked, about $0.0002 per session on Opus 5. A static security scan graded it A with 1 finding (makes network calls). No closer match exists in the catalogue, so it is treated as the original; first seen 2026-09-03.

Related

Other skills, from other repositories

Technical Documentation Writer

Write developer documentation that developers actually read. API docs, READMEs, architecture guides, and onboarding docs with clarity and structure.

demo112/yunqu-ai-skills · 30 tokens

technical-documentation

AI-powered technical documentation creation, maintenance, and auditing across README, ADR, API docs, runbooks, onboarding guides, changelogs, knowledge bases, and AI agent context files (AGENTS.md/CLAUDE.md). Primary keywords: technical documentation writing automation, ADR architecture decision record, API docs…

JPeetz/agent-skills · 115 tokens

document-writer

Write or update technical documentation grounded in the real codebase. Use when the user asks for README, API docs, architecture guides, user guides, CONTRIBUTING docs, migration notes, or JSDoc/code comments, or wants technical docs rewritten into natural Chinese with correct terminology. Not for general prose…

bahayonghang/my-ai-cli-toolkit · 75 tokens

documentation-writer

Write clear technical documentation including READMEs, API docs, architecture guides, and inline documentation. Use when creating or improving project documentation.

asgarovf/locusai · 31 tokens

documentation

Technical writing, API docs, and documentation best practices.

miles990/claude-software-skills · 12 tokens

documentation-patterns

Technical documentation patterns for READMEs, ADRs, API docs (OpenAPI 3.1), changelogs, and writing style guides. Use when creating project documentation, writing architecture decisions, documenting APIs, or maintaining changelogs.

yonatangross/orchestkit · 53 tokens