ReddRadar
Agent skill
documentation-generator
Generate documentation for migrated systems including API docs, architecture docs, and runbooks
Install this agent skill to your Project
npx add-skill https://github.com/a5c-ai/babysitter/tree/main/library/specializations/code-migration-modernization/skills/documentation-generator
SKILL.md
Documentation Generator Skill
Generates comprehensive documentation for migrated systems including API documentation, architecture diagrams, and operational runbooks.
Purpose
Enable documentation creation for:
- API documentation generation
- Architecture documentation
- Runbook generation
- Change documentation
- Diagram generation
Capabilities
1. API Documentation Generation
- Generate from OpenAPI specs
- Create interactive docs
- Include examples
- Support versioning
2. Architecture Documentation
- Create architecture diagrams
- Document components
- Map dependencies
- Explain patterns
3. Runbook Generation
- Create operational procedures
- Document troubleshooting
- Include escalation paths
- Generate playbooks
4. Change Documentation
- Document migration changes
- Track before/after
- Note breaking changes
- Generate release notes
5. Migration Guide Creation
- Create upgrade guides
- Document migration steps
- Include rollback procedures
- Provide checklists
6. Diagram Generation
- Generate architecture diagrams
- Create sequence diagrams
- Build data flow diagrams
- Produce deployment diagrams
Tool Integrations
| Tool | Purpose | Integration Method |
|---|---|---|
| Swagger UI | API docs | CLI |
| AsyncAPI | Event docs | CLI |
| PlantUML | Diagrams | CLI |
| Mermaid | Diagrams | Markdown |
| Backstage | Developer portal | Config |
| MkDocs | Documentation site | CLI |
Output Schema
{
"generationId": "string",
"timestamp": "ISO8601",
"documentation": {
"api": {
"path": "string",
"format": "string"
},
"architecture": {
"path": "string",
"diagrams": []
},
"runbooks": [],
"guides": []
},
"artifacts": {
"site": "string",
"pdfs": [],
"diagrams": []
}
}
Integration with Migration Processes
- documentation-migration: Primary doc generation
- All migration processes (change documentation)
Related Skills
openapi-generator: API spec generationknowledge-extractor: Source material
Related Agents
documentation-migration-agent: Doc orchestrationoperational-readiness-agent: Runbook creation
Recommended Agent Skills
Expand your agent's capabilities with these related and highly-rated skills.
a5c-ai/babysitter
gsd-tools
Central utility skill for GSD operations. Provides config parsing, slug generation, timestamps, path operations, and orchestrates calls to other specialized skills. Acts as the unified entry point that the original gsd-tools.cjs provided via its lib/ modules (commands, config, core, init).
a5c-ai/babysitter
model-profile-resolution
Resolve model profile (quality/balanced/budget) at orchestration start and map agents to specific models. Enables cost/quality tradeoffs by selecting appropriate AI models for each agent role.
a5c-ai/babysitter
verification-suite
Plan structure validation, phase completeness checks, reference integrity verification, and artifact existence confirmation. Provides the structured verification layer ensuring GSD artifacts are well-formed and complete.
a5c-ai/babysitter
state-management
STATE.md reading, writing, and field-level updates. Provides cross-session state persistence via .planning/STATE.md with structured fields for current task, completed phases, blockers, decisions, and quick tasks.
a5c-ai/babysitter
git-integration
Git commit patterns, formats, and conventions for GSD methodology. Provides atomic commits per task, structured commit messages, planning file commits, branch management, and milestone tag operations.
a5c-ai/babysitter
frontmatter-parsing
YAML frontmatter parsing and manipulation for .planning/ documents. Provides read, write, update, query, and validation operations on frontmatter blocks in GSD markdown artifacts.
Didn't find tool you were looking for?