documentation-automation

documentation-automation is a skill for Codex from PracticalSwan/agent-skills. It costs 52 tokens per session (997 once invoked), scanned A, original, MIT.

A workflow for automating documentation quality with tools such as JSDoc and TSDoc, which generate documentation from code comments. It also covers checks for Markdown, links, spelling, examples, and documentation changes.

In plain words
What is it for?
Setting up documentation scripts, API documentation generation, Markdown linting, link checking, and automated documentation checks in a project.
Why use it?
It moves documentation checks from manual review into repeatable local, pre-commit, and CI checks. This helps catch broken links, invalid examples, and formatting problems earlier.

Skill for Codex

Written for Codex: reads ~/.codex or $CODEX_HOME. Also seen: mentions subagents; mentions Claude Code; mentions Codex.

Good fit Setting up documentation scripts, API documentation generation, Markdown linting, link checking, and automated documentation checks in a project.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/practicalswan/agent-skills/documentation-automation
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 PracticalSwan/agent-skills --skill documentation-automation
Clone the repo
git clone --depth 1 https://github.com/PracticalSwan/agent-skills

Made for: 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-automation

README.md
[![agentmods](https://agentmods.dev/badge/skills/practicalswan/agent-skills/documentation-automation.svg)](https://agentmods.dev/skills/practicalswan/agent-skills/documentation-automation)
Your own site
<a href="https://agentmods.dev/skills/practicalswan/agent-skills/documentation-automation"><img src="https://agentmods.dev/badge/skills/practicalswan/agent-skills/documentation-automation.svg" alt="Measured on agentmods" height="20"></a>
Per session 52 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 997 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.00052 $0.00997
Opus 5 $0.00026 $0.00498
Sonnet 5 $0.00010 $0.00199
Haiku 4.5 $0.00005 $0.00100

Measured yesterday against content hash 03d2475b1e27, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-07, from the pricing page.

Security

Grade A, and why

documentation-automation 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 yesterday.

The scan reads SKILL.md. This mod also ships 1 executable file (scripts/docs-pipeline-scaffold.py), listed below but not scanned — reading those needs a real analyzer, not pattern matching.

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.

documentation-automation/SKILL.md · 99 lines

How it starts

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

Documentation Automation

Use this skill when documentation quality should be enforced by scripts, CI, or local hooks instead of manual review alone.

  • Leverage native parallel subagent dispatch and 200k+ context windows where available.

Activation Conditions

Use symptom -> action triggers: when one matches, apply this skill and verify with the protocol below.

  • Adding docs:* scripts to a project
  • Setting up markdownlint, cspell, lychee, or remark-lint
  • Generating API docs from source comments
  • Adding pre-commit or CI validation for docs
  • Standardizing documentation checks across repositories

Automation Targets

  • Build generated API docs
  • Lint Markdown structure and style
  • Check internal and external links
  • Validate code examples and commands
  • Enforce changelog or README updates when behavior changes
  1. Add local commands that can run without CI.
  2. Make CI call the same commands.
  3. Keep failure output actionable and fast.
  4. Prefer incremental checks in pre-commit and fuller checks in CI.

Documentation Stack Reference

Inherit the shared stack from documentation-patterns: source-of-truth discovery, audience framing, structure selection, verification, and freshness checks. Keep this skill focused on automation pipelines instead of restating the full stack.

Anti-Patterns

  • Writing for the author instead of the reader: It bakes in unstated context and leaves the actual audience unsure what to do next.
  • Skipping concrete examples or commands: Abstract guidance is easy to approve and hard to apply correctly.
  • Letting links, screenshots, or versions drift: Polished formatting does not help if the instructions are no longer true.

Verification Protocol

Before claiming "skill applied successfully":

  1. Pass/fail: The Documentation Automation output identifies audience, purpose, source of truth, and freshness requirements.
  2. Pass/fail: Shared documentation-stack guidance is referenced instead of duplicating another documentation skill.
  3. Pass/fail: Claims, links, commands, examples, and screenshots are verified or explicitly marked unverified.
  4. Pressure-test scenario: Apply the skill to a doc request with a stale command, missing owner, and conflicting audience.
  5. Success metric: Zero undocumented assumptions; every reader-facing claim is sourced or scoped.

Read the full file on GitHub · 99 lines

Files

What ships with it

4 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. yesterday Changed 03d2475b1e27
  2. 4d ago Changed 49aa4463849d
  3. 7d ago First seen · 99 lines · 52 tokens per session scan A 96fc9b52d3e4

Subscribe to this mod's changes

documentation-automation is a skill published in the GitHub repository PracticalSwan/agent-skills (13 stars, last pushed 2d ago), licensed MIT. It adds 52 tokens to every session and 997 once invoked, about $0.0003 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-08-30.