Codebase Documenter

What it does

When your agent uses it

• Documenting code
• Making a project easier for new developers

Example prompts

• “/codebase-documenter”

Requirements

• Node.js

Workflow steps

7 steps, taken from the first numbered list in SKILL.md.

1. 1Start with "Why" - Explain purpose before implementation
2. 2Progressive Disclosure - Simple to complex
3. 3Provide Context - Why code exists, not just what it does
4. 4Include Examples - Concrete usage for every concept
5. 5Assume No Prior Knowledge - Define terms, avoid jargon
6. 6Visual Aids - Diagrams, file trees, flowcharts
7. 7Quick Wins - Get something running in 5 minutes

What it can do on your machine

Read from SKILL.md and the folder at commit 139c07b. It shows what the files ask for, not the result of running them.

• Tool permissions

  Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

  From allowed-tools in the SKILL.md frontmatter.

• Runs code

  Ships script files (JavaScript), which the agent can run.

  From the folder's file list and the shell code blocks in SKILL.md.

• Network

  No URLs in SKILL.md.

  From URLs in SKILL.md, links to its own repository left out.

• Credentials

  Names no API keys, tokens, secrets or passwords.

  From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Codebase Documenter loads about 1.1k tokens when it runs, and up to ~11k if it reads all its reference files. Until then it costs about 51 tokens; SKILL.md has 290 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it

~51

When it runs · the whole SKILL.md, loaded when a task matches

~1.1k

With references · SKILL.md plus every file in references/, read only if the agent opens them

~11k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from travisjneuman/.claude at commit 139c07b, republished under its MIT licence (© travisjneuman). 290 words, ~1,085 tokens.

name

codebase-documenter

description

Write codebase documentation: READMEs, architecture docs, getting-started guides, API docs, and code comments. Use when documenting code or making a project easier for new developers.

context

fork

# Project Name

## What This Does

[1-2 sentence explanation]

## Quick Start

[< 5 minute setup]

## Project Structure

[Visual file tree]

## Key Concepts

[Core abstractions]

## Common Tasks

[Step-by-step guides]

# Architecture Overview

## System Design

[High-level diagram]

## Data Flow

[How data moves through system]

## Key Design Decisions

[Why certain choices were made]

## Extension Points

[Where to add new features]

// ✅ GOOD - Explains WHY and context
// IndexedDB quota check: Prevents silent failures when storage is full.
// Without this, writes fail with cryptic QuotaExceededError.
if (quota.percentUsed > 80) showStorageWarning();

// ❌ BAD - Just repeats what code does
// Check if quota is over 80

## Endpoint: POST /api/resource

### What It Does

[Plain-English purpose]

### Request/Response

[JSON examples]

### Common Errors

[Error codes and meanings]

project/
├── src/                    # Source code
│   ├── components/        # Reusable UI
│   ├── services/          # Business logic
│   └── types/             # TypeScript types
├── tests/                 # Test files
└── package.json           # Dependencies

User Request Flow:
1. User submits → 2. Validation → 3. API → 4. Database → 5. Response

[1] components/Form.tsx
    ↓ validates
[2] services/validation.ts
    ↓ calls API
[3] services/api.ts
    ↓ queries
[4] Database
    ↓ returns
[5] Form.tsx (updates UI)

## Why We Use [Technology]

**Decision:** [What we chose]
**Context:** [Why we needed to choose]
**Reasoning:** [Why this option]
**Trade-offs:** [What we gave up]

© travisjneuman, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

SKILL.md and 8 other files (references, assets) in skills/codebase-documenter of travisjneuman/.claude.

• SKILL.md
• assets/templates/API.template.md
• assets/templates/ARCHITECTURE.template.md
• assets/templates/CODE_COMMENTS.template.md
• assets/templates/README.template.md
• index.js
• package.json
• references/documentation_guidelines.md
• references/visual_aids_guide.md

Open the folder on GitHubat commit 139c07b