Skip to main content
plugin

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

Install into Claude Code · Plugin marketplace All methods and platforms ↓
/plugin marketplace add ccplugins/awesome-claude-code-plugins
/plugin install codebase-documenter@awesome-claude-code-plugins
Open on GitHub

What 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.md to 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-plugins

Step 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.

codebase-documenter rohitg00 codebase-documenter — a Claude Code plugin that documents a whole codebase automatically. It adds inline comments and writes API docs. ★ 2,858repo stars acquire-codebase-knowledge official github acquire-codebase-knowledge is a GitHub Copilot skill that maps an existing repository and writes project documentation. It runs when asked to explain an architecture, map a codebase, or document a project for onboarding. CX Codex +1 2,200installs codebase-onboarding Alireza Rezvani codebase-onboarding is a Claude Code skill that examines a repository and helps assemble project onboarding material. It runs for new-engineer introductions and architecture briefs. CX Codex +1 698installs gsd-map-codebase open-gsd The gsd-map-codebase Claude Code skill maps an existing project and writes seven codebase documents. Its full scan delegates separate areas of analysis to parallel agents. CX Codex +1 589installs codebase-wiki Inkeep codebase-wiki — a skill for Claude Code, Codex, Cursor, GitHub Copilot, and Gemini CLI that instructs the agent to build and maintain a source-grounded wiki inside the repository. CX Codex +1 461installs codebase-summarizer patricio0312rev codebase-summarizer scans your repository and writes ARCHITECTURE.md: entry points, module relationships, Mermaid diagrams and where-to-edit guides. CX Codex +1 411installs codebase-explorer davila7 codebase-explorer maps an unfamiliar project’s stack, architecture, entry points, and data flow. It can also write findings to CLAUDE.md on request. CX Codex 256installs

From the same set184

The whole set →
customer-success-manager customer-success-manager — a customer success subagent for B2B enterprise accounts. Helps track client health, reduce churn risk, and spot account expansion opportunities. ★ 1,013repo stars context7-docs-fetcher context7-docs-fetcher is a Claude Code plugin that retrieves Context7 documentation for specific libraries and frameworks. The agent steps in for implementation questions or setup guidance. ★ 1,013repo stars content-creator content-creator — a content subagent for Claude. It installs from the plugin marketplace and runs as a separate agent you can hand writing tasks to. ★ 1,013repo stars compliance-automation-specialist compliance-automation-specialist automates compliance workflows and audit preparation for SOC 2, ISO 27001, GDPR, and HIPAA in B2B systems. ★ 1,013repo stars code-reviewer code-reviewer — a plugin that analyzes code for quality, security, and maintainability right after you write or modify it. Runs with a single command and delivers detailed feedback. ★ 1,013repo stars code-architect code-architect — a Claude Code subagent that plans scalable software architecture, establishes folder layouts, and defines microservice boundaries. ★ 1,013repo stars ceo-quality-controller-agent ceo-quality-controller-agent acts as the final checkpoint before a commit or deploy, pulling in other project subagents and running a security check. Useful once several agents finish their work and the results need one combined review. ★ 1,013repo stars brand-guardian brand-guardian sets up brand guidelines, maintains visual consistency across touchpoints, and manages project brand assets in Claude Code. ★ 1,013repo stars

Project sponsors

Companies that keep this analytics open