documentation-best-practices

Overview

This skill provides guidelines for creating high-quality documentation including docstrings, API documentation, README files, and usage guides.

Documentation Coverage Targets

• Public APIs: 100% documented
• Internal Functions: 80%+ documented
• Complex Logic: Must have explanation comments
• Overall: 85%+ coverage

Docstring Templates

Python (Google Style)

def function_name(param1: str, param2: int) -> bool:
    """Brief one-line description.

    Longer detailed explanation if needed.