メニュー
Automated documentation generation specialist for technical specs, API docs, user guides, and knowledge bases with multi-format output
デフォルトでは、最初にソースを確認する Prompt が選択されています。直接コマンドに切り替えるか、ローカルコピーをダウンロードすることもできます。
インストールを決める前に、SKILL.md と SkillsMP に表示されている付属ファイルをお読みください。
Codex または Claude でインストール この Prompt をコピーして Codex、Claude、または他のアシスタントに貼り付けると、Skill ページを確認してインストールできます。
直接コマンドでは確認用 Prompt が省略されます。実行前にソースを確認してください。
npx skills add https://github.com/rdmptv/AdbAutoPlayer --skill moai-docs-generationコマンドは1行のまま表示されます。コピー前に横へスクロールして全体を確認してください。
ローカルで確認しますか？SkillsMP が現在取得できるファイルをダウンロードできます。
SOC 職業分類に基づく
SKILL.md を表示中
| name | moai-docs-generation |
| description | Automated documentation generation specialist for technical specs, API docs, user guides, and knowledge bases with multi-format output |
| version | 1.0.0 |
| category | workflow |
| tags | ["documentation","generation","automation","markdown","html","api-docs"] |
| updated | "2025-11-30T00:00:00.000Z" |
| status | active |
| author | MoAI-ADK Team |
Automated Documentation Generation - Comprehensive documentation automation covering technical specs, API documentation, user guides, and knowledge base creation with multi-format output capabilities.
Core Capabilities:
When to Use:
Basic Documentation Generation:
from moai_docs_generation import DocumentationGenerator
# Initialize generator
doc_gen = DocumentationGenerator()
# Generate API documentation
api_docs = doc_gen.generate_api_docs("path/to/your/app.py")
# Create user guide
user_guide = doc_gen.generate_user_guide(project_info)
# Export to multiple formats
doc_gen.export_to_formats(api_docs, formats=["html", "pdf", "markdown"])
Single Command Documentation:
# Generate complete documentation
moai generate-docs --source ./src --output ./docs --formats html,pdf
# Update API docs from code
moai update-api-docs --app-file app.py --format openapi
# Create tutorial from feature
moai create-tutorial --feature authentication --output docs/tutorials/
modules/api-documentation.md)modules/code-documentation.md)modules/user-guides.md)modules/multi-format-output.md)Git Hooks for Auto-Documentation:
# .git/hooks/pre-commit
#!/bin/bash
# Auto-update documentation before commits
python -c "
from moai_docs_generation import DocumentationGenerator
doc_gen = DocumentationGenerator()
doc_gen.update_documentation_for_changed_files()
"
CI/CD Pipeline Integration:
# .github/workflows/docs.yml
name: Generate Documentation
on:
push:
branches: [main]
jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Generate Documentation
run: |
moai generate-docs --source ./src --output ./docs
moai deploy-docs --platform github-pages
Smart Content Generation:
# AI-powered example generation
ai_enhanced_docs = doc_gen.generate_with_ai(
source_code="path/to/code",
enhancement_level="comprehensive",
include_examples=True,
include_troubleshooting=True
)
Automated Quality Checks:
# Validate documentation quality
quality_report = doc_gen.validate_documentation(
completeness_threshold=0.9,
include_example_validation=True,
check_link_integrity=True
)
Complementary Skills:
moai-foundation-core - SPEC-first documentation approachmoai-workflow-project - Project documentation integrationmoai-lang-unified - Multi-language code documentationmoai-integration-mcp - External documentation platform integrationTechnology Integration:
# Complete documentation suite
moai docs:generate --project ./my-project --output ./docs
# API documentation only
moai docs:api --source ./app.py --format openapi,html
# User guide creation
moai docs:guide --features auth,user-management --template getting-started
# Documentation updates
moai docs:update --sync-with-code --validate-links
from moai_docs_generation import DocumentationGenerator
# Complete workflow
generator = DocumentationGenerator()
docs = generator.generate_comprehensive_docs(
source_directory="./src",
include_api_docs=True,
include_user_guides=True,
output_formats=["html", "pdf", "markdown"]
)
# Individual components
api_gen = API Documentation Generation()
api_spec = api_gen.generate_openapi_spec(fastapi_app)
code_gen = Code Documentation Enhancement()
enhanced_docs = code_gen.analyze_and_enhance("./src/")
Core Technologies:
Optional Integrations:
Output Formats:
For detailed implementation patterns and advanced configurations, see the modules/ directory.