codebase-documenter · ccplugins — Claude Code plugin: docs and installation
The codebase-documenter agent examines a service or codebase component and writes documentation to CLAUDE.md files. Use it after adding a service, making a major refactor, or changing project structure.
Apache-2.0 ★ 1,013 updated 2026-08-12
/plugin marketplace add ccplugins/awesome-claude-code-plugins
/plugin install codebase-documenter@awesome-claude-code-pluginsWhat codebase-documenter does
codebase-documenter examines a service or a component in the codebase, then records its documentation in CLAUDE.md. It can capture how a newly implemented service works or bring project notes in line with the current codebase structure.
The described use cases are new services, major refactoring, and documentation updates after structural changes. For instance, ask it to document a newly added API module. Its output goes into CLAUDE.md, so a request for another documentation format falls outside the stated workflow.
What it helps with
- document a new service in
CLAUDE.md - describe a newly added API module
- refresh project docs after a major refactor
Example prompts for the agent
- Document how the new authentication service works in
CLAUDE.md. - Write documentation for the new API module in
CLAUDE.md. - Update
CLAUDE.mdto match the current codebase structure.
How to install codebase-documenter
Plugin marketplace
/plugin marketplace add ccplugins/awesome-claude-code-plugins/plugin install codebase-documenter@awesome-claude-code-pluginsStep by step, with commands for each platform: Claude Code plugins: marketplaces, installing, and building your own
Questions about codebase-documenter
How do I install codebase-documenter in Claude Code?
Add the marketplace with /plugin marketplace add ccplugins/awesome-claude-code-plugins, then install the plugin with /plugin install codebase-documenter@awesome-claude-code-plugins.
What does codebase-documenter do?
It examines a service or codebase component and creates documentation for it in CLAUDE.md files. The agent is intended for documentation work after implementation or project changes.
When should I run codebase-documenter?
Run it after implementing a service, completing a major refactor, or changing the codebase structure in a way that calls for updated documentation.
Source text
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
Similar plugins
All plugins for Writing and docs →codebase-documenter by other authors comes first.