Code Documenter

Overview

Analyzes source code to generate accurate, context-aware documentation at multiple levels: inline comments for complex logic, function/class docstrings, module-level overviews, architecture documents, and onboarding guides. Understands control flow, data transformations, side effects, and cross-module dependencies.

Instructions

When asked to document code:

1. Determine the documentation level needed:

   • Inline: Function/method docstrings, JSDoc, Python docstrings, Go doc comments
   • Module: README or header comment explaining the module's purpose and exports
   • Architecture: High-level document showing how modules interact, data flows, key design decisions
   • Onboarding: Getting-started guide for new team members

2. For function/method documentation, extract:

   • Purpose: What does this function do? (one sentence)
   • Parameters: name, type, description, default values, constraints