API Documentation

Best practices for documenting APIs and code interfaces. Eliminates ~100-150 lines of redundant documentation guidance per agent.

Core Documentation Principles

1. Document the why, not just the what - Explain intent and rationale
2. Keep docs close to code - Inline documentation stays synchronized
3. Document contracts, not implementation - Focus on behavior
4. Examples are essential - Show real usage
5. Update docs with code - Outdated docs are worse than no docs

Function/Method Documentation

Python (Docstrings)

def calculate_discount(price: float, discount_percent: float) -> float:
    """
    Calculate discounted price with percentage off.