documentation-3-automated-api-documentation
Sub-skill of documentation: 3. Automated API Documentation (+2).
Best use case
documentation-3-automated-api-documentation is best used when you need a repeatable AI agent workflow instead of a one-off prompt.
Sub-skill of documentation: 3. Automated API Documentation (+2).
Teams using documentation-3-automated-api-documentation should expect a more consistent output, faster repeated execution, less prompt rewriting.
When to use this skill
- You want a reusable workflow that can be run more than once with consistent structure.
When not to use this skill
- You only need a quick one-off answer and do not need a reusable workflow.
- You cannot install or maintain the underlying files, dependencies, or repository context.
Installation
Claude Code / Cursor / Codex
Manual Installation
- Download SKILL.md from GitHub
- Place it in
.claude/skills/3-automated-api-documentation/SKILL.mdinside your project - Restart your AI agent — it will auto-discover the skill
How documentation-3-automated-api-documentation Compares
| Feature / Agent | documentation-3-automated-api-documentation | Standard Approach |
|---|---|---|
| Platform Support | Not specified | Limited / Varies |
| Context Awareness | High | Baseline |
| Installation Complexity | Unknown | N/A |
Frequently Asked Questions
What does this skill do?
Sub-skill of documentation: 3. Automated API Documentation (+2).
Where can I find the source code?
You can find the source code on GitHub using the link provided at the top of the page.
SKILL.md Source
# 3. Automated API Documentation (+2)
## 3. Automated API Documentation
```python
# Generate API docs from docstrings
"""
Module description.
Example:
>>> import mymodule
>>> mymodule.function()
'result'
"""
*See sub-skills for full details.*
## 4. Version Documentation
```bash
# Version docs with releases
version_docs() {
local version="$1"
# MkDocs with mike
mike deploy "$version" latest -u
mike set-default latest
# Docusaurus
npm run docusaurus docs:version "$version"
}
```
## 5. Link Validation
```bash
# Check for broken links
check_links() {
local docs_dir="${1:-docs}"
# Using markdown-link-check
find "$docs_dir" -name '*.md' -exec markdown-link-check {} \;
# Using linkchecker on built site
linkchecker ./site/index.html
}
```Related Skills
documentation-contract-plan-hardening
Harden a documentation/contract plan before adversarial review by mapping every issue-scope requirement to independent acceptance criteria and tests, especially for routing/indexing contracts.
modular-architecture-documentation
Systematically document multi-module system architectures including module boundaries, CLI commands, and architecture decisions.
orcawave-aqwa-benchmark-automated-validation-in-pipeline
Sub-skill of orcawave-aqwa-benchmark: Automated Validation in Pipeline.
orcaflex-modeling-external-documentation
Sub-skill of orcaflex-modeling: External Documentation.
github-modes-automated-issue-management
Sub-skill of github-modes: Automated Issue Management.
github-issue-tracker-3-automated-progress-updates
Sub-skill of github-issue-tracker: 3. Automated Progress Updates (+5).
gitbook-example-1-documentation-site-builder
Sub-skill of gitbook: Example 1: Documentation Site Builder (+2).
docusaurus-1-documentation-structure
Sub-skill of docusaurus: 1. Documentation Structure (+2).
documentation-testing-documentation
Sub-skill of documentation: Testing Documentation.
documentation-step-1
Sub-skill of documentation: Step 1 (+1).
documentation-static-site-generators
Sub-skill of documentation: Static Site Generators (+2).
documentation-project-structure
Sub-skill of documentation: Project Structure (+3).