Documentation Automation
Use this skill when documentation quality should be enforced by scripts, CI, or local hooks instead of manual review alone.
Activation Conditions
- 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.
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
Related Skills
| Skill | Relationship |
|---|---|
| documentation-authoring | Generate docs that automation tools process |
| devops-tooling | Pre-commit hooks and CI pipeline integration |
| documentation-verification | Automated validation in doc pipelines |