Packages Documentation

What it does

This skill generates documentation for software packages. It can analyze package files and produce formatted documentation, including descriptions of functions, classes, and modules. The generated documentation aims to be clear, concise, and easily understandable by developers.

When to use it

• Creating API references: Generate comprehensive documentation for a library or framework's public API.
• Onboarding new team members: Quickly create documentation to help new developers understand the codebase.
• Automating documentation updates: Keep documentation synchronized with code changes through automated generation.
• Generating user guides: Produce user-friendly guides explaining how to use a software package.

Key capabilities

• Package file analysis
• Formatted documentation generation
• Description of functions, classes and modules
• Clear and concise writing style

Example prompts

• "Generate documentation for the 'my-package' library."
• "Create API reference documentation for all public functions in this code."
• “Can you document the ‘data-client’ package?”

Tips & gotchas

The quality of the generated documentation depends heavily on the clarity and structure of the original package files. Ensure your code includes sufficient comments to facilitate accurate documentation generation.