Code documentation

Skill lexicalninja/my-little-scrum-team/skills/code-documentation

Generate comprehensive code documentation including docstrings, comments, and API documentation. Use when code lacks documentation, needs better explanations, or requires API docs. Focuses on clarity, completeness, and following language-specific documentation standards.From its SKILL.md

Install

npx -y skills add lexicalninja/my-little-scrum-team --skill code-documentation

Assembled from the repository path, not quoted from the project. Check it against their README if it does not work.

One thing to look at

2 stars2 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.

SKILL.md

3.1 KB, as published. Nobody here has run it

Code Documentation Skill

Instructions

Analyze the code structure to understand what needs documentation
Generate docstrings/comments following language conventions:
- Python: Google, NumPy, or Sphinx style
- JavaScript/TypeScript: JSDoc format
- Go: Standard Go doc comments
- Java: JavaDoc format
Document:
- Function/method purpose and behavior
- Parameters with types and descriptions
- Return values with types and descriptions
- Exceptions/errors that may be raised
- Usage examples when helpful
- Edge cases and important notes
Add inline comments for complex logic or non-obvious code
Generate API documentation when requested
Keep documentation concise but complete
Use clear, professional language

Examples

Input (Python function without docs):

def calculate_total(items, tax_rate=0.1):
    subtotal = sum(item.price for item in items)
    return subtotal * (1 + tax_rate)

Output:

def calculate_total(items: List[Item], tax_rate: float = 0.1) -> float:
    """
    Calculate the total price including tax for a list of items.
    
    Args:
        items: List of Item objects with a price attribute
        tax_rate: Tax rate as a decimal (default: 0.1 for 10%)
    
    Returns:
        Total price including tax as a float
    
    Example:
        >>> items = [Item(price=10.0), Item(price=20.0)]
        >>> calculate_total(items, tax_rate=0.08)
        32.4
    """
    subtotal = sum(item.price for item in items)
    return subtotal * (1 + tax_rate)

Input (JavaScript function):

function processUserData(data) {
    const filtered = data.filter(u => u.active);
    return filtered.map(u => ({ id: u.id, name: u.name }));
}

Output:

/**
 * Process user data by filtering active users and extracting key fields.
 * 
 * @param {Array<Object>} data - Array of user objects
 * @param {boolean} data[].active - Whether the user is active
 * @param {string} data[].id - User identifier
 * @param {string} data[].name - User display name
 * @returns {Array<Object>} Array of processed user objects with id and name
 * 
 * @example
 * const users = [
 *   { id: '1', name: 'Alice', active: true },
 *   { id: '2', name: 'Bob', active: false }
 * ];
 * processUserData(users); // [{ id: '1', name: 'Alice' }]
 */
function processUserData(data) {
    const filtered = data.filter(u => u.active);
    return filtered.map(u => ({ id: u.id, name: u.name }));
}

Documentation Standards

Python:

Use Google or NumPy style docstrings
Include type hints when possible
Document exceptions with Raises:
Add Example: section for complex functions

JavaScript/TypeScript:

Use JSDoc format with @param, @returns, @throws
Include type information in JSDoc comments
Add @example for usage demonstrations