Code Documentation

What it does

This skill instructs AI agents to generate clear, structured documentation for codebases, functions, or specific logic blocks. It transforms raw source code into readable explanations that highlight purpose, inputs, outputs, and usage patterns.

When to use it

• You need to onboard new developers to an existing project without reading every line of code manually.
• You want to create API reference guides or function signatures for a library you are building.
• You need to explain complex algorithms or legacy systems to stakeholders who lack technical backgrounds.
• You are preparing code for open-source publication and require standard README or docstring formats.

Key capabilities

• Analyzes source code files to extract logic and dependencies.
• Generates human-readable summaries of function behavior and parameters.
• Produces structured documentation suitable for Markdown, JSDoc, or Python docstrings.
• Identifies edge cases and potential usage scenarios within the provided code context.

Example prompts

• "Analyze this Python script and write a comprehensive README explaining its main features and how to run it."
• "Generate detailed JSDoc comments for every function in this JavaScript module, including parameter descriptions and return values."
• "Explain the logic behind this specific algorithm in plain English, focusing on how data flows through the system."

Tips & gotchas

Ensure you provide the full relevant code context or a representative sample; fragmented snippets may lead to incomplete explanations. While the skill excels at summarizing existing logic, it cannot infer undocumented business rules that are not explicitly visible in the code structure.