documentation - Generate Google-style Documentation and Docstrings
Creates Google-style docstrings and comprehensive documentation for code.
Tags
Updated: 2026-02-12Capabilities
Typical Inputs
Typical Outputs
What this skill does
- Use Google-style docstrings
- Write module-level docstrings
- Document function signatures
- Add type hints
- Create README files
- Generate API documentation
- Include architecture diagrams
- Document environment variables
- Add deprecation warnings
- Use Sphinx or MkDocs
- Include executable examples
- Document error cases
- Add See Also references
- Include performance notes
- Document thread-safety
- Use consistent terminology
- Include changelog
Inputs
- source code
- configuration files
- environment variables
Outputs
- docstrings in code
- README.md file
- API documentation
- architecture diagrams
Requirements
- Python environment
- documentation tools (Sphinx/MkDocs)