documentation-standards

documentation-standards is a skill for Claude Code, Codex from sigistry/marketplace. It costs 77 tokens per session (2,214 once invoked), scanned A, original, MIT.

A skill that provides language-specific formats and quality guidelines for documenting code, such as docstrings, JSDoc, and documentation comments.

In plain words
What is it for?
Use it when adding, generating, auditing, or correcting code documentation across different programming languages.
Why use it?
It helps documentation explain intent and important context instead of merely repeating what the code already says.

Skill for Claude CodeCodex

Written for no agent in particular: nothing here depends on one.

Part of the doc-generator plugin — 2 skills, 3 commands, 2 agents shipped together

Good fit Use it when adding, generating, auditing, or correcting code documentation across different programming languages.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/sigistry/marketplace/documentation-standards
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.

Any agent
npx skills add sigistry/marketplace --skill documentation-standards
Clone the repo
git clone --depth 1 https://github.com/sigistry/marketplace

Made for: Claude Code, Codex.

Or install doc-generator, the plugin that ships this one along with the rest of its 2 skills, 3 commands, 2 agents.

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/sigistry/marketplace/documentation-standards/github.svg)](https://agentmods.dev/skills/sigistry/marketplace/documentation-standards)
Your own site
<a href="https://agentmods.dev/skills/sigistry/marketplace/documentation-standards"><img src="https://agentmods.dev/badge/skills/sigistry/marketplace/documentation-standards/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for documentation-standards

Your own site · 80×15
<a href="https://agentmods.dev/skills/sigistry/marketplace/documentation-standards"><img src="https://agentmods.dev/badge/skills/sigistry/marketplace/documentation-standards.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 77 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 2,214 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
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.1 $0.00077 $0.02214
Opus 5 $0.00039 $0.01107
Sonnet 5 $0.00015 $0.00443
Haiku 4.5 $0.00008 $0.00221

Measured 6d ago against content hash 8d9a0058c25f, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-09, from the pricing page.

Security

Grade A, and why

documentation-standards scanned grade A with 0 findings 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 6d 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.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

plugins/doc-generator/skills/documentation-standards/SKILL.md · 212 lines

How it starts

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

Documentation Standards

Purpose

Define language-specific documentation formats, quality standards, and writing principles for generating, auditing, and maintaining code documentation. Apply these standards consistently across all documentation-related operations.

Core Principles

Explain the Why, Not the What

Focus documentation on intent, rationale, and context rather than restating what the code already expresses. A function named calculateTax does not need a description that says "calculates tax." Instead, describe which tax rules apply, what edge cases exist, and why a particular algorithm was chosen.

Weak:

/** Sorts the array. */
function sortUsers(users) { ... }

Strong:

/**
 * Sort users by subscription tier (premium first), then by join date.
 *
 * Premium users appear first to ensure priority support routing.
 * Within the same tier, older accounts take precedence per SLA policy.
 */
function sortUsers(users) { ... }

Use Active Voice

Write descriptions in active voice, present tense. Start function descriptions with a verb.

Preferred Avoid
"Validate user credentials against the auth database" "User credentials are validated"
"Return the cached result if available" "The cached result is returned"
"Parse the CSV file into a list of records" "A list of records is parsed from the CSV"

Completeness Requirements

Document every public API with all of the following:

  1. Brief summary -- one sentence stating what the function does
  2. Parameters -- every parameter with type, description, default value, and constraints
  3. Return value -- type, meaning, and edge-case values (e.g., null when not found)
  4. Exceptions/errors -- every error condition with its cause
  5. Side effects -- I/O operations, state mutations, event emissions, network calls
  6. At least one example -- realistic, runnable usage demonstrating the common case

Read the full file on GitHub · 212 lines

Files

What ships with it

2 files beside SKILL.md in the same directory: the scripts, references and assets a skill reads on demand. Not counted in the per-session cost; read them before you install if any of them is executable.

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. 6d ago First seen · 212 lines · 77 tokens per session scan A 8d9a0058c25f

Subscribe to this mod's changes

documentation-standards is a skill published in the GitHub repository sigistry/marketplace (3 stars, last pushed today), licensed MIT. It adds 77 tokens to every session and 2,214 once invoked, about $0.0004 per session on Opus 5. A static security scan graded it A with 0 findings. 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

design-everyday-things

Apply foundational design principles: affordances, signifiers, constraints, feedback, and conceptual models. Use when the user mentions "why is this confusing", "affordance", "error prevention", "discoverability", "human-centered design", "mental model", "mapping", "seven stages of action", "users keep making…

wondelai/skills · 132 tokens

cold-start-problem

Start and scale networked products using Andrew Chen's "The Cold Start Problem" framework for network effects. Use when the user mentions "network effects", "chicken and egg", "cold start", "two-sided marketplace", "atomic network", "hard side", "liquidity", "critical mass", "invite-only launch", "how do I get my…

wondelai/skills · 168 tokens

37signals-way

Build lean, opinionated products using the 37signals philosophy from "Getting Real", "Rework", and "Shape Up". Use when the user mentions "Getting Real", "Rework", "Shape Up", "37signals", "Basecamp method", "six-week cycles", "fixed time variable scope", "appetite vs estimates", "betting table", "breadboarding", "fat…

wondelai/skills · 177 tokens

clean-architecture

Structure software around the Dependency Rule: source code dependencies point inward from frameworks to use cases to entities. Use when the user mentions "architecture layers", "dependency rule", "ports and adapters (hexagonal)", "onion architecture", "screaming architecture", "where should business logic go"…

wondelai/skills · 147 tokens

release-it

Build production-ready systems with stability patterns: circuit breakers, bulkheads, timeouts, and retry logic. Use when the user mentions "production outage", "circuit breaker", "deployment pipeline", "chaos engineering", "retry storm", "health checks", "my service keeps crashing", "prevent cascading failures", or…

wondelai/skills · 131 tokens

root-cause-investigator

Systematic root cause analysis for errors, bugs, and unexpected behaviors using 5-Why methodology. Use when user reports errors, build failures, test failures, performance issues, integration problems, or any "it's not working" scenarios.

umputun/cc-thingz · 53 tokens