Code Documentation Analyzer

What it does

The code-documentation-analyzer skill analyzes code documentation to identify missing or incomplete information. It can extract function descriptions, parameter details, and return types from existing docstrings. This helps ensure that code is well-documented and understandable for other developers.

When to use it

• Reviewing pull requests: Quickly assess the quality of documentation changes in a new feature branch.
• Automated documentation generation: Supplement automatically generated documentation with more detailed explanations.
• Code refactoring: Ensure that documentation is updated alongside code modifications.
• Onboarding new team members: Provide clear and concise documentation for existing codebase.

Key capabilities

• Extracts function descriptions from docstrings.
• Identifies missing parameter details.
• Detects incomplete return type information.

Example prompts

• "Analyze the documentation in this Python file and identify any missing parameters."
• "Check if the return types are documented for all functions in this JavaScript code snippet."
• “Review these docstrings and suggest improvements to clarity.”

Tips & gotchas

The skill's effectiveness depends on the quality of existing docstrings; poorly written or absent documentation will limit its ability to provide useful insights. It is best used as a supplement to manual review, not a replacement for it.