codebase-documenter · ccplugins — плагин для Claude Code: документация проекта
Агент codebase-documenter анализирует сервис или часть кодовой базы и создаёт документацию в файлах CLAUDE.md. Его вызывают после добавления сервиса, крупного рефакторинга или обновления проекта.
Apache-2.0 ★ 1 013 обновлён 2026-08-12
/plugin marketplace add ccplugins/awesome-claude-code-plugins
/plugin install codebase-documenter@awesome-claude-code-pluginsЧто делает codebase-documenter
codebase-documenter разбирает сервис или компонент кодовой базы и оформляет сведения о нём в CLAUDE.md. Так можно зафиксировать устройство нового сервиса или привести документацию в соответствие с текущей структурой проекта.
Плагин рассчитан на задачи после реализации сервиса, крупного рефакторинга и изменений, из-за которых документация устарела. Например, попросите описать новый модуль API. Агент работает с CLAUDE.md, поэтому запрос на документацию в другом формате не соответствует описанному сценарию.
Какие задачи решает
- описать новый сервис в
CLAUDE.md - документировать добавленный модуль API
- обновить документацию после крупного рефакторинга
Примеры запросов агенту
- Опиши, как устроен новый сервис авторизации, и запиши документацию в
CLAUDE.md. - Задокументируй новый модуль API в
CLAUDE.md. - Обнови
CLAUDE.md, чтобы он отражал текущую структуру проекта.
Как установить codebase-documenter
Через маркетплейс плагинов
/plugin marketplace add ccplugins/awesome-claude-code-plugins/plugin install codebase-documenter@awesome-claude-code-pluginsПо шагам, с командами для каждой платформы: Плагины Claude Code: маркетплейсы, установка и как собрать свой
Вопросы о codebase-documenter
Как установить codebase-documenter в Claude Code?
Сначала добавьте маркетплейс командой /plugin marketplace add ccplugins/awesome-claude-code-plugins, затем установите плагин командой /plugin install codebase-documenter@awesome-claude-code-plugins.
Что делает codebase-documenter?
Он анализирует сервис или компонент кодовой базы и создаёт для него документацию в CLAUDE.md. Его используют после реализации сервиса, рефакторинга или изменений проекта.
Когда стоит запускать codebase-documenter?
Запускайте его после добавления сервиса или крупного рефакторинга, а также когда документацию нужно обновить с учётом текущей структуры кодовой базы.
Исходный текст
codebase-documenter · Apache-2.0
Use this agent when you need to analyze a service or codebase component and create comprehensive documentation in CLAUDE.md files. This agent should be invoked after implementing new services, major refactoring, or when documentation needs updating to reflect the current codebase structure. Examples: <example>Context: The user has just implemented a new authentication service and wants to document it properly. user: 'I just finished implementing the auth service, can you document how it works?' assistant: 'I'll use the codebase-documenter agent to analyze the authentication service and create detailed documentation in CLAUDE.md' <commentary>Since the user has completed a service implementation and needs documentation, use the Task tool to launch the codebase-documenter agent to create comprehensive CLAUDE.md documentation.</commentary></example> <example>Context: The user wants to ensure a newly added API module is properly documented for the team. user: 'We need documentation for the new payment processing API I just added' assistant: 'Let me use the codebase-documenter agent to analyze the payment processing API and create proper documentation' <commentary>The user needs documentation for a new API module, so use the codebase-documenter agent to create CLAUDE.md files with setup instructions and architectural notes.</commentary></example>
© Anand Tyagi · Apache-2.0 · ccplugins/awesome-claude-code-plugins
Похожие плагины
Все плагины по теме «Тексты и документация» →Сначала — codebase-documenter от других авторов.