code-mapper
Create, update, and review code-map and spec documents for features. Use this skill to document code execution flows, trace function calls, and maintain architectural documentation in docs/2-current/.
When & Why to Use This Skill
The code-mapper skill automates the creation and maintenance of comprehensive technical documentation, including execution flow maps and architectural specifications. By tracing function calls and documenting business logic, it ensures that project documentation remains a living, accurate reflection of the codebase, significantly reducing cognitive load for developers and improving system maintainability.
Use Cases
- Feature Onboarding: Helping new developers quickly grasp complex logic by providing visual execution flows and component call graphs for specific features.
- Refactoring & Impact Analysis: Mapping out existing code paths and dependencies before making architectural changes to ensure all edge cases and side effects are accounted for.
- Automated Spec Maintenance: Keeping API definitions, database schemas, and architectural diagrams in sync with the actual implementation through structured spec documents.
- Complex Debugging: Tracing deep execution flows from entry points (like API endpoints) to identify exactly where logic branches or exceptions occur in the call stack.
| name | code-mapper |
|---|---|
| description | Create, update, and review code-map and spec documents for features. Use this skill to document code execution flows, trace function calls, and maintain architectural documentation in docs/2-current/. |
Code Mapper
Create and maintain code-map and spec documents that accurately reflect the codebase.
Document Types
| Type | Pattern | Purpose |
|---|---|---|
| Code-map | docs/2-current/map-*.md |
Trace execution flows |
| Spec | docs/2-current/spec-*.md |
Architecture, schemas, APIs |
Analysis Process
- Identify starting point: API endpoint, function, command line
- Trace execution: Follow code from entry to completion
- Document control flow: Conditions, branches, exceptions
- Create sub-flows: Tree structure for complex paths
- Capture business logic: Input options, edge cases
Code-Map Structure
See references/codemap-guide.md for complete format.
# Feature Name
## Summary
## Major Flow Blocks
## Flow Diagram (Mermaid)
## Component Call Graph
## Starting Trace Block [[↑ Flow Diagram](#flow-diagram)]
## Sub-flow A [[↑ Flow Diagram](#flow-diagram)]
## Helper Functions [[↑ Flow Diagram](#flow-diagram)]
## Configuration and Environment [[↑ Flow Diagram](#flow-diagram)]
## Error Handling Summary [[↑ Flow Diagram](#flow-diagram)]
## Database Schema Integration [[↑ Flow Diagram](#flow-diagram)]
## Business Logic Summary [[↑ Flow Diagram](#flow-diagram)]
## Dependencies [[↑ Flow Diagram](#flow-diagram)]
Spec Documents
For non-execution information:
- Database schemas
- API endpoint definitions
- Data types and models
- Architecture diagrams
- External component integration
Link spec documents from/to related code-map documents.
Key Requirements
- Use relative file paths with line numbers:
[file.py:123](../../path/file.py#L123) - Include
[[↑ Flow Diagram](#flow-diagram)]on section headers - Document all inputs, outputs, and error cases
- Link all function references to their sections
- Keep Mermaid diagrams navigable with anchor links