repo-scanning
Scan and document repository structure, patterns, and key components. Use when starting work on unfamiliar codebases.
When & Why to Use This Skill
The repo-scanning skill automates the discovery and documentation of complex codebases, providing a high-level architectural overview. It generates a comprehensive repository map that identifies key modules, naming conventions, and entry points, significantly reducing the time required for developers to understand and navigate unfamiliar projects.
Use Cases
- New Developer Onboarding: Quickly orient new team members by providing an automated map of the repository's structure and core components.
- Legacy Codebase Analysis: Document the organization and patterns of older projects to facilitate maintenance and identify technical debt.
- Architectural Auditing: Scan repositories to ensure that directory structures and module boundaries align with intended design patterns.
- Pre-Refactoring Documentation: Create a baseline map of a project's current state before performing major structural changes or migrations.
| name | repo-scanning |
|---|---|
| description | Scan and document repository structure, patterns, and key components. Use when starting work on unfamiliar codebases. |
Repository Scanning
Produce a comprehensive map of the repository to enable effective navigation and understanding.
Process
- Identify major directories and their purposes
- Find key modules, services, or packages
- Note conventions and patterns in use
- Document entry points and important files
- Flag any unusual structures or concerns
Output
Create context/repo-map.md using the template in templates/repo-map.md.
Tips
- Focus on structure, not implementation details
- Note naming conventions observed
- Identify test directories and their organization
- Look for configuration files that reveal project setup