Codebase Summary

Codebase Summary

Overview

This sop analyzes a codebase and generates comprehensive documentation including structured metadata files that describe the system architecture, components, interfaces, and workflows. It can create targeted documentation files like AGENTS.md (README for AI agents), README.md, CONTRIBUTING.md, or generate a complete documentation ecosystem. The documentation is organized to make it easy for AI assistants to understand the system and help with development tasks.

Parameters

• output_dir (optional, default: ".agents/summary"): Directory where documentation will be stored
• consolidate (optional, default: true): Whether to create consolidated documentation files
• consolidate_targets (optional, default: "AGENTS.md"): Target files for consolidation, comma-separated (e.g., "AGENTS.md, README.md, CONTRIBUTING.md"). Only used if consolidate is true
• consolidate_prompt (optional): Description of how to structure the consolidated content for the target file type (e.g., Reference the AGENTS.md example below for the default "consolidate_prompt"). Only used if consolidate is true
• check_consistency (optional, default: true): Whether to check for inconsistencies across documents
• check_completeness (optional, default: true): Whether to identify areas lacking sufficient detail
• update_mode (optional, default: false): Whether to update existing documentation based on recent changes
• codebase_path (optional, default: current directory): Path to the codebase to analyze

Constraints for parameter acquisition:

• You MUST ask for all parameters upfront in a single prompt rather than one at a time
• You MUST support multiple input methods including:
  • Direct input: Text provided directly in the conversation
  • File path: Path to a local file containing codebase information
  • Directory path: Path to the codebase to analyze
  • Other methods: You SHOULD be open to other ways the user might want to specify the codebase
• You MUST use appropriate tools to access content based on the input method
• You MUST confirm successful acquisition of all parameters before proceeding
• You MUST validate that the codebase_path exists and is accessible
• If consolidate is false, you MUST inform the user that consolidate_targets and consolidate_prompt will be ignored

Steps

1. Setup and Directory Structure

Initialize the analysis environment and create necessary directory structure.

Constraints:

• You MUST validate that the codebase_path exists and is accessible
• You MUST create the output_dir if it doesn't exist
• You MUST inform the user about the directory structure being created
• If update_mode is true, you MUST:
  • Check if {output_dir}/.last_commit exists to determine the baseline commit
  • Use git commands to review commits since the baseline and identify changes
• If update_mode is false or no previous documentation exists, you MUST inform the user that full analysis will be performed
• You MUST create subdirectories for organizing different types of documentation artifacts

2. Analyze Codebase Structure

Perform comprehensive analysis of the codebase to understand its structure, components, and relationships.

Constraints:

• You MUST use appropriate tools to gather information about the codebase structure
• You MUST identify all packages, modules, and major components in the codebase
• You MUST analyze file organization, directory structure, and architectural patterns
• You MUST identify supported and unsupported programming languages
• You MUST document the technology stack and dependencies
• You MUST create a hierarchical map of the codebase structure using Mermaid diagrams
• You MUST identify key interfaces, APIs, and integration points
• You MUST analyze code patterns and design principles used throughout the codebase
• You MUST use Mermaid diagrams for all visual representations instead of ASCII art
• You MUST document basic codebase information in {output_dir}/codebase_info.md
• If update_mode is true, you MUST:
  • Analyze which packages and files were modified in recent commits
  • Prioritize analysis of modified components
  • Create a change summary document listing all relevant changes since last update

3. Generate Documentation Files

Create comprehensive documentation files for different aspects of the system.

Constraints:

• You MUST create a comprehensive knowledge base index file ({output_dir}/index.md) that:
  • Provides explicit instructions for AI assistants on how to use the documentation
  • Contains rich metadata about each file's purpose and content
  • Includes a table of contents with descriptive summaries for each document
  • Explains relationships between different documentation files
  • Guides AI assistants on which files to consult for specific types of questions
  • Contains brief summaries of each file's content to help determine relevance
  • Is designed to be the primary file needed in context for AI assistants to effectively answer questions
• You MUST create documentation files for different aspects of the system:
  • {output_dir}/architecture.md (system architecture and design patterns)
  • {output_dir}/components.md (major components and their responsibilities)
  • {output_dir}/interfaces.md (APIs, interfaces, and integration points)
  • {output_dir}/data_models.md (data structures and models)
  • {output_dir}/workflows.md (key processes and workflows)
  • {output_dir}/dependencies.md (external dependencies and their usage)
• You MUST ensure each documentation file contains relevant information from the codebase analysis
• You MUST use Mermaid diagrams for all visual representations throughout the documentation
• You MUST NOT use ASCII art for any visual elements
• If update_mode is true, you MUST:
  • Preserve existing documentation structure where possible
  • Only update sections related to modified components

4. Review Documentation

Review the documentation for consistency and completeness.

Constraints:

• If check_consistency is true, you MUST check for inconsistencies across documents
• If check_completeness is true, you MUST identify areas lacking sufficient detail
• You MUST document any inconsistencies or gaps found in {output_dir}/review_notes.md
• You MUST specifically identify gaps resulting from language support limitations
• You SHOULD use insights from the codebase analysis to identify areas needing more detail
• You MUST provide recommendations for improving documentation quality