Documentation Automation
- 16 installs
- 7 repo stars
- Updated August 2, 2026
- practicalswan/agent-skills
documentation-automation is a Claude Code skill for documentation.
About
documentation-automation is a Claude Code skill for documentation. It helps solo builders move faster with AI-assisted development.
- documentation-automation
- Documentation
- AI-coding skill
Documentation Automation by the numbers
- 16 all-time installs (skills.sh)
- Ranked #1,053 of 1,879 Documentation skills by installs in the Skillselion catalog
- Data as of Aug 4, 2026 (Skillselion catalog sync)
npx skills add https://github.com/practicalswan/agent-skills --skill documentation-automationAdd your badge
Show developers this skill is listed on Skillselion. Paste this into your README.
| Installs | 16 |
|---|---|
| repo stars | ★ 7 |
| Last updated | August 2, 2026 |
| Repository | practicalswan/agent-skills ↗ |
How do I helps with documentation tasks.?
Helps with documentation tasks.
Who is it for?
Best when you're working on documentation and need structured help with documentation automation.
Skip if: Teams with no documentation needs, or anyone wanting a generic chat assistant without this specific workflow.
When should I use this skill?
When you need to helps with documentation tasks., or when documentation-automation is a claude code skill for documentation.
What you get
Structured output aligned to documentation-automation: documentation-automation, Documentation.
Files
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: 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.
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
<!-- PORTABILITY:START -->
Cross-Client Portability
This skill is written to stay usable across GitHub Copilot, Claude Code, Codex, and Gemini CLI.
- GitHub Copilot: keep the folder in a Copilot-visible skill or plugin path, or wrap the workflow as project instructions if the host does not support portable skill folders directly.
- Claude Code: keep the folder in a local skills directory or a compatible plugin or marketplace source.
- Codex: install or sync the folder into
$CODEX_HOME/skills/<skill-name>and restart Codex after major changes. - Gemini CLI: this repository generates a project command named
/skills:documentation-automationfrom this skill. Rebuild commands withpython scripts/export-gemini-skill.py documentation-automationand then run/commands reloadinside Gemini CLI.
<!-- PORTABILITY:END -->
<!-- MCP:START -->
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.
<!-- MCP:END -->
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.
Changelog
[2026-04-25] - Version 1.2 Verification Protocol Refresh
Added
- Added a
Verification Protocolsection with skill-specific pass/fail checks, one pressure-test scenario, and a measurable success metric. - Added guidance to leverage native parallel subagent dispatch and 200k+ context windows where available.
- Added or referenced the shared documentation-stack approach to reduce duplicated documentation guidance.
Changed
- Updated
SKILL.mdfrontmatter toversion: "1.2"andlast_updated: 2026-04-25. - Reframed activation guidance toward symptom -> action triggers and standardized two-stage review wording where applicable.
[2026-04-24] - Version 1.1 Refresh
Changed
- Updated the SKILL frontmatter version to
1.1for the 2026-04-24 catalog refresh.
All notable changes to this skill will be documented in this file.
[2026-04-24] - Skill Refresh
Changed
- Standardized the SKILL frontmatter with version metadata, last-updated date, tags, and a concise catalog description.
- Reformatted the portability and MCP guidance with a preferred server line, a copy-paste fallback prompt, and consistent bullet lists.
- Added a catalog-standard Anti-Patterns section and refreshed the Related Skills links at the end of the skill.
[2026-04-04] - Cross-Client Portability Refresh
Changed
- Added a standard portability note covering GitHub Copilot, Claude Code, Codex, and Gemini CLI.
- Clarified that the core workflow does not require a dedicated MCP server and can run with local tools alone.
Tested
- Validated
SKILL.mdfrontmatter, portability sections, and Gemini export readiness withpython scripts/validate-skills.py.
[2026-03-09] - Workspace Modernization
Changed
- Rewrote the skill around practical local-plus-CI documentation automation patterns
Added
scripts/docs-pipeline-scaffold.pyfor generating starterdocs:*automation commands
[2026-02-28] — Description Rewrite & Cross-References
Changed
- Rewrote skill description to ~200 characters with clear, specific activation keywords
- Improved keyword specificity to reduce overlap with related skills
Added
## Related Skillscross-reference table with 2-4 related skills and "Use When" guidance
MIT License
Copyright (c) 2026 Sithu Win San
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Automated Documentation Tools
Language-Specific Tools
| Language | Documentation Tool | Notes |
|---|---|---|
| JavaScript | JSDoc | Standard for JS, adds type annotations |
| TypeScript | TSDoc | Native TS doc comments, generates types |
| Python | Sphinx | Full-featured, supports multiple formats |
| Python | pdoc | Simple, auto-generation from docstrings |
| Java | Javadoc | Java standard, HTML output |
| C# | xmldoc | XML-based documentation |
| Go | godoc | Go native, web-based output |
| Rust | rustdoc | Rust native, includes tests |
Setup Examples
JSDoc for JavaScript
npm install --save-dev jsdoc/**
* Calculate sum of two numbers.
* @param {number} a - First number
* @param {number} b - Second number
* @returns {number} Sum of a and b
*/
function add(a, b) {
return a + b;
}TSDoc for TypeScript
/**
* Calculate sum of two numbers.
* @param a - First number
* @param b - Second number
* @returns Sum of a and b
*/
function add(a: number, b: number): number {
return a + b;
}Linting Tools
Markdown Linting
npm install --save-dev markdownlint-cli
npx markdownlint "*.md"Link Checking
npm install --save-dev markdown-link-check
markdown-link-check *.mdSpell Checking
npm install --save-dev cspell
cspell "**/*.md"#!/usr/bin/env python3
"""Print starter documentation automation commands for common stacks."""
from __future__ import annotations
import argparse
import json
def node_config() -> dict[str, str]:
return {
"docs:lint": "markdownlint '**/*.md'",
"docs:links": "lychee --no-progress .",
"docs:spell": "cspell .",
"docs:validate": "npm run docs:lint && npm run docs:links && npm run docs:spell",
}
def python_config() -> dict[str, str]:
return {
"docs:lint": "markdownlint '**/*.md'",
"docs:links": "python scripts/doc-link-check.py .",
"docs:spell": "cspell .",
"docs:validate": "python -m subprocess_placeholder",
}
def main() -> int:
parser = argparse.ArgumentParser(description=__doc__)
parser.add_argument("--stack", choices=("node", "python"), default="node")
args = parser.parse_args()
scripts = node_config() if args.stack == "node" else python_config()
print(json.dumps({"scripts": scripts}, indent=2))
print()
print("CI checklist:")
print("- Install doc tooling dependencies")
print("- Run the same docs:validate command used locally")
print("- Upload any generated doc artifacts only after validation passes")
return 0
if __name__ == "__main__":
raise SystemExit(main())
Related skills
Lark MarkdownInstantly turn any markdown file into clean, formatted Lark/Figma-compatible documents without manual reformatting.488k
Lark DocCreate, read, update, summarize, rewrite and manage Feishu/Lark cloud documents directly from agent workflows.401k16.1kLark WikiCreate, organize, query, and manage documents, spaces, and members inside Lark (Feishu) knowledge bases directly from AI agent workflows.397k16.1k
Domain ModelingBuild and sharpen a project's domain model: pin down domain terminology in a glossary and record architectural decisions as ADRs.318k202k
Opensource Guide CoachGet expert, attribution-safe guidance on launching and sustaining an open-source project.270k71Readme I18nMaintain consistent, updatable language selector blocks across every README variant in a multilingual repository.270k71FAQ
What does documentation-automation do?
documentation-automation is a Claude Code skill for documentation.
When should I use documentation-automation?
When you need to helps with documentation tasks., or when documentation-automation is a claude code skill for documentation.
What are the main capabilities?
documentation-automation; Documentation; AI-coding skill.