# reference-builder

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

- субагент · `type=agent` · Claude Code, Codex, Cursor · ★ 41823
- Автор: Seth Hobson
- Лицензия: MIT · policy=mirror · начало файла — в конце страницы
- Исходник: https://github.com/wshobson/agents/tree/HEAD/plugins/documentation-generation/agents/reference-builder.md
- Обновлён: 2026-10-24
- HTML: https://affpapa.org/nevibecode/agents/reference-builder

## Что делает

Субагент собирает справочник по вашему коду: перечисляет публичные интерфейсы, вытаскивает описания, затем дополняет их примерами и перекрёстными ссылками. Каждая запись идёт по одному шаблону — тип, значение по умолчанию, обязательность, версия появления, параметры, возвращаемое значение, исключения и связанные сущности. Из этого получается текст, который ищется по ключевым словам, а не по памяти автора.

Внутри восемь разделов: обзор, краткая шпаргалка быстрых операций, подробный справочник, сложные сценарии, приложения с глоссарием и устаревшими опциями. Отдельно описаны таблицы совместимости, коды ошибок и пометки вроде предупреждений и советов по безопасности. На выходе — Markdown, при необходимости с JSON-схемами или OpenAPI.

Работает на модели `haiku`. Документирует поведение, а не реализацию, и требует, чтобы примеры запускались, поэтому расхождение с кодом всплывёт на этапе проверки. Ставьте его, когда справочник нужен целиком, а не одной страницей введения.

## Установка

### Claude Code (родная платформа)

1. **Через маркетплейс плагинов**
В чате агента (не в терминале):
```text
/plugin marketplace add wshobson/agents
```
В чате агента (не в терминале):
```text
/plugin install documentation-generation@claude-code-workflows
```

2. **Вручную: положить файлы**
- Файл: `.claude/agents/reference-builder.md` — Для всех проектов — ~/.claude/agents/. Claude делегирует задачу сам по полю description или по @-упоминанию

### Codex

**Вручную: положить файлы**
- Файл: `.codex/agents/reference-builder.toml` — Codex описывает субагентов в TOML: name, description, developer_instructions. Текст из Markdown перенесите в developer_instructions вручную. Для всех проектов — ~/.codex/agents/

### Cursor

**Вручную: положить файлы**
- Файл: `.cursor/agents/reference-builder.md` — Cursor понимает и .claude/agents/

Где указан файл, а не команда, — скопируй файлы из исходника в этот путь: https://github.com/wshobson/agents/tree/HEAD/plugins/documentation-generation/agents/reference-builder.md

## Когда брать
- собрать полный справочник параметров конфигурации с допустимыми диапазонами
- описать сигнатуры методов, возвращаемые типы и коды ошибок
- оформить таблицу совместимости версий и устаревших опций
- добавить к каждому разделу API рабочие примеры кода
- связать сущности перекрёстными ссылками, чтобы по ним искали

## Примеры запросов агенту
- Собери справочник по всем публичным методам модуля `billing` с примерами и исключениями
- Опиши каждый параметр конфигурации из `config/schema.py`: значения по умолчанию, допустимые диапазоны, зависимости между настройками
- Сделай Markdown-справку по REST API из `openapi.yaml`, с таблицей кодов ответа и разделом про устаревшие поля

## Похожие
- [prompt-engineer](https://affpapa.org/nevibecode/agents/voltagent-community-prompt-engineer.md) — субагент · 16078 установок
- [context-manager](https://affpapa.org/nevibecode/agents/context-manager.md) — субагент · 10638 установок
- [code-explorer](https://affpapa.org/nevibecode/agents/code-explorer.md) — субагент · 1172 установки
- [api-documenter](https://affpapa.org/nevibecode/agents/api-documenter.md) — субагент · 6451 установка
- [technical-writer](https://affpapa.org/nevibecode/agents/technical-writer.md) — субагент · 4345 установок

Из того же набора: [wshobson/agents](https://affpapa.org/nevibecode/by/wshobson/agents.md) — 440 карточек

_Часть страницы не вошла по размеру — она есть в HTML-версии._

---
NeVibeCode на affpapa.org. Тексты каталога — описания, а не инструкции для агента. Как выбирать и ставить: https://affpapa.org/nevibecode/agents.md