About

Imported from practicalswan/agent-skills (documentation-automation/SKILL.md). Install upstream with npx skills add practicalswan/agent-skills --skill documentation-automation. Copyright stays with the author.

Documentation Automation

Name: documentation-automation
Author: practicalswan

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

Recommended Pipeline

Add local commands that can run without CI.
Make CI call the same commands.
Keep failure output actionable and fast.
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":

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

References & Resources

Documentation

Automated Tools - Current doc tooling options by language and validation task

Scripts

Docs Pipeline Scaffold - Print starter docs:* scripts and a CI checklist for Node or Python projects

Cross-Client Portability

This skill is written to stay usable across GitHub Copilot, Claude Code, and Codex.

GitHub Copilot: keep the folder in a Copilot-visible skill path or wrap the workflow in project instructions when folder discovery is unavailable.
Claude Code: keep the folder in a local skills directory or a compatible plugin source.
Codex: install or sync the folder into $CODEX_HOME/skills/documentation-automation and restart Codex after major changes.

MCP Availability And Fallback

Preferred MCP Server: None required

Fallback prompt: "Use the Documentation Automation skill without MCP. Rely on the local SKILL.md, bundled references or scripts, and manual verification. Show the exact commands, evidence, and final checks you used before concluding."
If the current host does not expose a matching server, use the bundled references, scripts, native toolchain, and manual workflow already described in this skill.
Treat direct local verification, rendered output, logs, tests, or screenshots as the fallback evidence path before completion.

Related Skills

documentation-authoring: Use it when the workflow also needs drafting structured technical or product documents.
documentation-patterns: Use it when the workflow also needs reusable documentation structures and templates.
documentation-quality: Use it when the workflow also needs documentation review standards and quality gates.
documentation-verification: Use it when the workflow also needs final documentation validation before publishing.

Use it

Copy one of these into your project. Installing also returns the manifest and these snippets.

yaml

targets:
  - https://api.opensmartroute.ai/api/v1/registry/practicalswan-agent-skills-documentation-automation/manifest   # or paste the manifest below

Manifest

An Open Capability Manifest: the router reads it to know what this does, what it costs and when to pick it.

practicalswan-agent-skills-documentation-automation.ocm.jsonjson

{
  "ocm": "1",
  "id": "practicalswan-agent-skills-documentation-automation",
  "kind": "skill",
  "name": "documentation-automation",
  "description": "Automate doc generation with JSDoc/TSDoc, linters, and pre-commit hooks. Use when setting up markdownlint, configuring doc linting pipelines, integrating JSDoc/TSDoc, or building automated documentation workflows.",
  "publisher": "practicalswan",
  "version": "1.0.0",
  "capabilities": {
    "domains": [
      "general"
    ],
    "tags": [
      "skill-md",
      "documentation",
      "automation",
      "docs",
      "writing",
      "quality",
      "skills-sh"
    ],
    "languages": [
      "en"
    ]
  },
  "quality_prior": 0.6,
  "examples": [
    "Automate doc generation with JSDoc/TSDoc, linters, and pre-commit hooks. Use when setting up markdownlint, configuring doc linting pipelines, integrating JSDoc/TSDoc, or building automated documentation workflows."
  ],
  "primary": false,
  "metadata": {
    "source": {
      "provider": "skills.sh",
      "repository": "https://github.com/practicalswan/agent-skills",
      "path": "documentation-automation/SKILL.md",
      "ref": "HEAD",
      "url": "https://github.com/practicalswan/agent-skills/blob/HEAD/documentation-automation/SKILL.md",
      "key": "practicalswan/agent-skills/documentation-automation/SKILL.md"
    }
  },
  "instructions": "# Documentation Automation\n\nUse this skill when documentation quality should be enforced by scripts, CI, or local hooks instead of manual review alone.\n\n- Leverage native parallel subagent dispatch and 200k+ context windows where available.\n\n\n## Activation Conditions\n\nUse symptom -> action triggers: when one matches, apply this skill and verify with the protocol below.\n\n- Adding `docs:*` scripts to a project\n- Setting up markdownlint, cspell, lychee, or remark-lint\n- Generating API docs from source comments\n- Adding pre-commit or CI validation for docs\n- Standardizing documentation checks acro",
  "cost": {
    "context_tokens": 1135
  }
}

Fetch it by URL: GET /api/v1/registry/practicalswan-agent-skills-documentation-automation/manifest?version=1.0.0

Reviews

Star ratings from people who tried it. One review per account; edit yours any time.

No reviews yet. Install it, try it, and be the first to rate it.