К основному содержанию
скилл CX Codex

codebase-documenter · travisjneuman — скилл для Claude Code: README, архитектура, API

Скилл codebase-documenter для Claude Code пишет документацию по репозиторию: README, описание архитектуры, гайд для новичков, API и комментарии в коде. Помогает объяснить проект новому разработчику.

MIT 145 установок ★ 114 обновлён 2026-11-10

Установить в Claude Code · Через Skills CLI (Vercel) Все способы и платформы ↓
npx skills add travisjneuman/.claude --skill codebase-documenter -a claude-code
Открыть на GitHub

Что делает codebase-documenter

Скилл проходит по репозиторию и собирает документацию: точки входа, зависимости, конфигурацию, ключевые абстракции. Дальше выбирает тип документа по порядку README, архитектура, API, комментарии, заполняет шаблоны под проект и прогоняет проверку. Перед текстом он всегда объясняет, зачем код нужен, и только потом как он работает.

Внутри набор шаблонов: README с быстрым стартом и деревом файлов, страница архитектуры с потоком данных и разделом про принятые решения, формат ADR с компромиссами, примеры хороших и плохих комментариев. Отдельно лежит чек-лист перед публикацией: примеры копипастятся, пути и ссылки верные, жаргон расшифрован. И список типичных провалов вроде устаревших примеров или пропущенных требований.

Верификация здесь — чтение: скилл сверяет примеры с текущим кодом и путями, но не запускает их. Сломанный по синтаксису пример такую проверку пройдёт. Ревью кода, UX-решения и новые фичи он не берёт и отправляет к generic-code-reviewer, generic-ux-designer и generic-feature-developer.

Какие задачи решает

  • написать README, по которому проект запускается за 5 минут
  • описать архитектуру и показать поток данных диаграммой
  • задокументировать эндпоинты с примерами запроса и ответа
  • переписать комментарии так, чтобы они объясняли причину, а не повторяли код
  • прогнать готовую документацию по чек-листу перед публикацией

Примеры запросов агенту

  • Задокументируй проект: собери README с быстрым стартом и деревом файлов
  • Опиши архитектуру src/services и покажи, как данные идут от формы до базы
  • Оформи эндпоинты из api/routes.ts как API-документацию с примерами

Как установить codebase-documenter

1Через Skills CLI (Vercel)

npx skills add travisjneuman/.claude --skill codebase-documenter -a claude-code

2Вручную: положить файлы

~/.claude/skills/codebase-documenter/SKILL.md

Папка скилла целиком; для одного проекта — .claude/skills/codebase-documenter/

По шагам, с командами для каждой платформы: Как установить скилл в Claude Code: пять способов

Вопросы о codebase-documenter

Как установить codebase-documenter в Claude Code?

Выполните npx skills add travisjneuman/.claude --skill codebase-documenter -a claude-code. Файл скилла появится в ~/.claude/skills/codebase-documenter/SKILL.md.

Что делает codebase-documenter?

Собирает документацию по коду: README, архитектурные заметки, гайд для новичков, описание API и комментарии. Работает по циклу: разбор проекта, выбор типа документа, генерация по шаблону, проверка.

Он заменяет ревью кода?

Нет. Ревью, UX-решения и разработку фич скилл не трогает и перенаправляет к generic-code-reviewer, generic-ux-designer и generic-feature-developer.

Исходный текст

SKILL.md · MIT
---
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
background: false
---

# Codebase Documenter

Create comprehensive, beginner-friendly documentation for any codebase.

## When to Use

**Use for:**

- Writing or updating README files
- Creating architecture documentation
- Adding meaningful code comments
- Documenting APIs and endpoints
- Creating getting-started guides
- Explaining project structure

**Don't use when:**

- Code review → use `generic-code-reviewer`
- UX design decisions → use `generic-ux-designer`
- Adding code features → use `generic-feature-developer`

## Core Principles

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

## Documentation Workflow

First follow [Memory and documentation](../../CLAUDE.md#memory-and-documentation) to update the owning subject note before generating repository documentation. The templates below describe public code/contributor docs, not default destinations for private project knowledge.

1. **Analyze** - Entry points, dependencies, core concepts, configuration
2. **Choose Type** - README → Architecture → API → Comments
3. **Generate** - Use templates, customize for project
4. **Verify** - Read as beginner, check examples against the code by reading

## Documentation Types

### README (Project Entry Point)

```markdown
# 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 Documentation

```markdown
# 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]
```

### Code Comments

```typescript
// ✅ 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
```

### API Documentation

```markdown
## Endpoint: POST /api/resource

### What It Does

[Plain-English purpose]

### Request/Response

[JSON examples]

### Common Errors

[Error codes and meanings]
```

## Visual Patterns

### File Tree

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

### Data Flow

```
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)
```

### Design Decision (ADR)

```markdown
## Why We Use [Technology]

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

## Documentation Quality Checklist

### Before Publishing

- [ ] Quick start works in < 5 minutes
- [ ] Code examples are copy-pasteable
- [ ] File paths are accurate
- [ ] Links work
- [ ] Jargon is defined
- [ ] Diagrams are included for complex flows

### Common Mistakes to Avoid

- Assuming reader knows the codebase
- Outdated code examples
- Missing prerequisites
- No visual aids for complex systems
- Explaining "what" without "why"

## Verification Workflow

After writing documentation:

1. **Fresh Eyes Test** - Read as if you've never seen the codebase
2. **Check Examples** - Read each example against the current code, APIs, and paths it uses
3. **Check Links** - All internal/external links resolve
4. **Beginner Review** - Would a new developer understand?
5. **Update Check** - Does it reflect current code?

## See Also

- [Code Review Standards](../_shared/CODE_REVIEW_STANDARDS.md) - Documentation quality
- Project `CLAUDE.md` - Documentation rules

## Your task

$ARGUMENTS

© travisjneuman · MIT · travisjneuman/.claude

Похожие скиллы

Все скиллы по теме «Тексты и документация» →

Сначала — codebase-documenter от других авторов.

codebase-documenter ailabs-393 Скилл codebase-documenter для Claude Code создаёт README, описания архитектуры, комментарии к коду и документацию API с объяснением архитектурных решений и пошаговым запуском проекта менее чем за 5 минут. CX Codex +1 1 500установок codebase-documenter mhattingpete Скилл codebase-documenter для Claude Code и Cursor обходит кодовую базу и создаёт документацию: архитектура, ключевые компоненты, потоки данных, гайды по разработке. CX Codex +1 595установок doc-forge rohitg00 Плагин doc-forge для Claude Code, который генерирует документацию по коду, API-доки и поддерживает README. Срабатывает по запросу агента при работе с проектом. ★ 2 858звёзд репо documentation официальный anthropics Скилл documentation для Claude Code готовит README, справочники API, ранбуки, архитектурные документы и гайды для новичков. Включается, когда код уже есть, а описания нет. CX Codex +1 10 800установок documentation-engineer zhaono1 Скилл documentation-engineer для Claude Code и Codex: пишет README, описания API, комментарии к коду и архитектурные заметки. Закрывает документацию там, где её нет. CX Codex +1 722установок code-documentation-analyzer Jeremy Longshore Автоактивируемый скилл для разбора документации кода: API-справочники, руководства пользователя, архитектурные описания. Включается по фразам вроде «code documentation analyzer» или «code analyzer». CX Codex +1 1установок documentation-templates davila7 Скилл documentation-templates для Claude Code, который предоставляет структуру и шаблоны для README, API-документации, комментариев и других проектных записей. Помогает оформить документацию с нуля или привести её к единому стилю. CX Codex +1 305установок gem-documentation-writer официальный github Субагент gem-documentation-writer для GitHub Copilot пишет техническую документацию, README, API-документацию и диаграммы. Он запускается по задаче на обновление документации или создание PRD. CX Codex +1 ★ 41 430звёзд репо

Из того же набора117

Весь набор →
generic-react-code-reviewer Скилл generic-react-code-reviewer проверяет React/TypeScript-код на баги, дыры в безопасности, просадки производительности и доступность, читая диф. Пригодится перед коммитом и на ревью пул-реквеста. CX Codex +1 148установок security Скилл security для Claude Code помогает проектировать меры защиты, разбирать инциденты и оценивать уязвимости. Подключается к задачам по NIST, ISO 27001, архитектуре безопасности и облачной защите. CX Codex +1 148установок generic-code-reviewer Скилл generic-code-reviewer проверяет код перед коммитом или мержем пуллреквеста. Находит уязвимости, проблемы с типами, ошибки доступности и сверяет правила с файлом CLAUDE.md. CX Codex +1 147установок monitoring-observability Скилл monitoring-observability помогает внедрить OpenTelemetry, структурированные логи и трейсинг в микросервисах. Он пригодится при настройке алертов по SLO и отладке распределённых систем. CX Codex +1 146установок impact-report-writer Скилл impact-report-writer для Claude Code собирает структуру отчёта о результатах программы, помогает выбрать метрики и визуализации. Он задаёт основу годового отчёта или оценки программы. CX Codex +1 145установок frontend-enhancer Скилл frontend-enhancer для Claude Code доводит визуал веб-приложения: палитру, сетки, анимации и состояния компонентов. Помогает доработать интерфейс, который всё ещё выглядит как дефолтный шаблон. CX Codex +1 145установок status-report-generator Скилл status-report-generator для Claude Code собирает проектные отчёты по истории Git, задачам и контрольным точкам. Запускается для еженедельных сводок, обзоров спринта и отчётов для заинтересованных сторон. CX Codex +1 145установок generic-ux-designer Скилл generic-ux-designer для Claude и других агентов: даёт UX-рамку для проектирования фич, ревью интерфейсов и оценки флоу, с чек-листами и форматом находок. CX Codex +1 145установок

Спонсоры проекта

Компании, которые помогают держать аналитику открытой