code-documentation

What it does

This skill generates comprehensive code documentation, including API documentation, README files, inline code comments, and full technical guides. It can be used to explain complex codebases, detail API functionality for developers, or create detailed user manuals. The output is designed to improve code maintainability and developer understanding.

When to use it

• Generating a README file: Quickly create an initial README for a new project outlining its purpose, installation instructions, and usage examples.
• Documenting API endpoints: Automatically generate documentation describing the parameters, responses, and functionality of individual API endpoints.
• Adding inline comments to code: Have the skill analyze existing code and suggest relevant comments explaining specific logic or algorithms.
• Creating a technical guide for users: Produce step-by-step instructions and explanations for using a software product or library.

Key capabilities

• API documentation generation
• README file creation
• Inline code commenting
• Technical guide writing

Example prompts

• "Generate a README file for my Python project, which is a web scraper for news articles."
• “Write API documentation for the /users endpoint, including request parameters and example responses.”
• "Add inline comments to this JavaScript function explaining how it calculates Fibonacci numbers: [paste code here]"

Tips & gotchas

The quality of the generated documentation depends heavily on the clarity and structure of the underlying code. Providing context about the intended audience (e.g., experienced developers vs. end-users) can also improve results.