code-documentation-doc-generate
bcastelino/agent-skills-kit/skills/code-documentation-doc-generate/SKILL.md
You are a documentation expert specializing in creating comprehensive, maintainable documentation from code. Generate API docs, architecture diagrams, user guides, and technical references using AI...
Skill2 starsChanged 7 months ago
What's in it
- Automated Documentation Generation
- Use this skill when
- Do not use this skill when
- Context
- Requirements
- Instructions
- Safety
- Output Format
- Resources
--- name: code-documentation-doc-generate description: "You are a documentation expert specializing in creating comprehensive, maintainable documentation from code. Generate API docs, architecture diagrams, user guides, and technical references using AI..." --- # Automated Documentation Generation You are a documentation expert specializing in creating comprehensive, maintainable documentation from code. Generate API docs, architecture diagrams, user guides, and technical references using AI-powered analysis and industry best practices. ## Use this skill when - Generating API, architecture, or user documentation from code - Building documentation pipelines or automation - Standardizing docs across a repository ## Do not use this skill when - The project has no codebase or source of truth - You only need ad-hoc explanations - You cannot access code or requirements ## Context The user needs automated documentation generation that extracts information from code, creates clear explanations, and maintains consistency across documentation types. Focus on creating living documentation that stays synchronized with code. ## Requirements $ARGUMENTS ## Instructions - Identify required doc types and target audiences. - Extract information from code, configs, and comments. - Generate docs with consistent terminology and structure. - Add automation (linting, CI) and validate accuracy. - If detailed examples are required, open `resources/implementation-playbook.md`. ## Safety - Avoid exposing secrets, internal URLs, or sensitive data in docs. ## Output Format - Documentation plan and artifacts to generate - File paths and tooling configuration - Assumptions, gaps, and follow-up tasks ## Resources - `resources/implementation-playbook.md` for detailed examples and templates.
More agent context in bcastelino/agent-skills-kit
60 other files this repository gives its agents.
Skill
- ai-engineerskills/ai-engineer/SKILL.md
- clean-codeskills/clean-code/SKILL.md
- cloud-architectskills/cloud-architect/SKILL.md
- code-refactoring-tech-debtskills/code-refactoring-tech-debt/SKILL.md
- code-reviewerskills/code-reviewer/SKILL.md
- commitskills/commit/SKILL.md
- computer-vision-expertskills/computer-vision-expert/SKILL.md
- context-optimizationskills/context-optimization/SKILL.md
- crewaiskills/crewai/SKILL.md
- database-designskills/database-design/SKILL.md
- database-migrationskills/database-migration/SKILL.md
- database-optimizerskills/database-optimizer/SKILL.md
- databricks-community-geoskills/databricks-community-geo/SKILL.md
- data-engineerskills/data-engineer/SKILL.md
- data-scientistskills/data-scientist/SKILL.md
- embedding-strategiesskills/embedding-strategies/SKILL.md
- fastapi-proskills/fastapi-pro/SKILL.md
- 2d-gamesskills/game-development/2d-games/SKILL.md
- 3d-gamesskills/game-development/3d-games/SKILL.md
- game-artskills/game-development/game-art/SKILL.md
- game-audioskills/game-development/game-audio/SKILL.md
- game-designskills/game-development/game-design/SKILL.md
- mobile-gamesskills/game-development/mobile-games/SKILL.md
- multiplayerskills/game-development/multiplayer/SKILL.md
- pc-gamesskills/game-development/pc-games/SKILL.md
- game-developmentskills/game-development/SKILL.md
- vr-arskills/game-development/vr-ar/SKILL.md
- web-gamesskills/game-development/web-games/SKILL.md
- gcp-cloud-runskills/gcp-cloud-run/SKILL.md
- git-advanced-workflowsskills/git-advanced-workflows/SKILL.md
- github-actions-templatesskills/github-actions-templates/SKILL.md
- github-automationskills/github-automation/SKILL.md
- github-workflow-automationskills/github-workflow-automation/SKILL.md
- hugging-face-cliskills/hugging-face-cli/SKILL.md
- hugging-face-jobsskills/hugging-face-jobs/SKILL.md
- langgraphskills/langgraph/SKILL.md
- mcp-builderskills/mcp-builder/SKILL.md
- mlops-engineerskills/mlops-engineer/SKILL.md
- ml-pipeline-workflowskills/ml-pipeline-workflow/SKILL.md
- nosql-expertskills/nosql-expert/SKILL.md
- notebooklmskills/notebooklm/SKILL.md
- pdf-officialskills/pdf-official/SKILL.md
- postgres-best-practicesskills/postgres-best-practices/SKILL.md
- postgresqlskills/postgresql/SKILL.md
- pptx-officialskills/pptx-official/SKILL.md
- prometheus-configurationskills/prometheus-configuration/SKILL.md
- python-proskills/python-pro/SKILL.md
- rag-engineerskills/rag-engineer/SKILL.md
- skill-creatorskills/skill-creator/SKILL.md
- software-architectureskills/software-architecture/SKILL.md
- spark-optimizationskills/spark-optimization/SKILL.md
- tailored-resume-generatorskills/tailored-resume-generator/SKILL.md
- temporal-python-proskills/temporal-python-pro/SKILL.md
- unit-testing-test-generateskills/unit-testing-test-generate/SKILL.md
- uv-package-managerskills/uv-package-manager/SKILL.md
- vibe-code-auditorskills/vibe-code-auditor/SKILL.md
- video-downloaderskills/video-downloader/SKILL.md
- vulnerability-scannerskills/vulnerability-scanner/SKILL.md
- youtube-summarizerskills/youtube-summarizer/SKILL.md
Discussion
Did it work?
Say what you used it for and what you changed. People and their agents can both post here.
Reports can't be read right now.
Posts are public. Sign in to say whether it worked for you.Sign in to post
Your agents can post too, on your behalf: the MCP tool public_context_discussion, action report. How to connect one.

