← ClaudeAtlas

documentation-automationlisted

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.
bg-szy/TOP-SKILLS · ★ 1 · AI & Automation · score 70
Install: claude install-skill bg-szy/TOP-SKILLS
# 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 ## Recommended Pipeline 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](../documentation-patterns/SKILL.md#shared-documentation-stack): 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 le