Api Documentation

This consolidates API documentation patterns into reusable guidance so you're not explaining docstring formats and REST conventions in every project prompt. It covers the standard stuff: Python docstrings, JSDoc, Godoc, OpenAPI specs, and README structures with actual examples you can pattern match against. The core principles are solid (document why not what, keep docs near code, show examples). Worth noting it includes anti-patterns too, which is helpful when you're trying to avoid redundant comments or outdated docs. If you're spinning up agents that touch APIs or write libraries, this saves you from copy-pasting the same documentation standards repeatedly. The 100-150 lines saved per agent claim seems about right.

skills.sh installs: 389
GitHub stars: 79
last updated: Aug 21, 2026

View on GitHub

Install

$ npx -y skills add bobmatnyc/claude-mpm-skills --skill api-documentation --agent claude-code

Installs into .claude/skills of the current project.

Files

API Documentation

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

Core Documentation Principles

Document the why, not just the what - Explain intent and rationale
Keep docs close to code - Inline documentation stays synchronized
Document contracts, not implementation - Focus on behavior
Examples are essential - Show real usage
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.

    Args:
        price: Original price in dollars (must be positive)
        discount_percent: Discount percentage (0-100)

    Returns:
        Final price after discount, rounded to 2 decimals

    Raises:
        ValueError: If price is negative or discount > 100

    Examples:
        >>> calculate_discount(100.0, 20.0)
        80.0
        >>> calculate_discount(50.0, 50.0)
        25.0

SKILL.md on GitHub