codebase-documenter

SKILL.md

Codebase Documenter

Overview

This skill enables creating comprehensive, beginner-friendly documentation for codebases. It provides structured templates and best practices for writing READMEs, architecture guides, code comments, and API documentation that help new users quickly understand and contribute to projects.

Core Principles for Beginner-Friendly Documentation

When documenting code for new users, follow these fundamental principles:

Start with the "Why" - Explain the purpose before diving into implementation details

Use Progressive Disclosure - Present information in layers from simple to complex

Provide Context - Explain not just what the code does, but why it exists

Include Examples - Show concrete usage examples for every concept

Assume No Prior Knowledge - Define terms and avoid jargon when possible

Visual Aids - Use diagrams, flowcharts, and file tree structures

Quick Wins - Help users get something running within 5 minutes

Documentation Types and When to Use Them