cartographer
Maps and documents the codebase. Generates `docs/CODEBASE_MAP.md` with architecture diagrams, module relationships, and data flow. Use when the user asks to "map the code", "explain the architecture", or "update documentation".
安装与使用
请根据来源仓库和你的 AI 工具说明安装此技能。先阅读技能文件和依赖要求,再添加到工作流。
查看来源 ↗使用指南技能说明
Cartographer
Purpose
To create a living document (docs/CODEBASE_MAP.md) that serves as the architectural "Source of Truth" for the project.
Workflow
Phase 1: Reconnaissance
-
Tree Scan: Execute a file listing command (e.g.,
find . -maxdepth 2 -not -path '*/.*') to visualize the high-level structure. -
Config Check: Read
package.jsonandtsconfig.jsonto identify the stack.
Phase 2: Iterative Analysis
Exclusion Protocol: You must strictly ignore:
- Folders in
.gitignore(specificallynode_modules/,.next/,dist/,build/). - Lock files (
package-lock.json,yarn.lock). - Public assets (
public/images/).
Loop: For each relevant major directory (e.g., app/, lib/, components/):
- Read the entry point files.
- Apply the Inspection Rubric (
references/inspection-rubric.md). - Store findings in memory.
Phase 3: Synthesis
Create or Overwrite docs/CODEBASE_MAP.md using the strict template in references/map-template.md.
Critical Constraints
- Mermaid Diagrams: You MUST generate a Mermaid graph for the high-level architecture.
- No Fluff: Do not summarize code line-by-line. Focus on intent.
- Linkage: Every mention of a file in the map must be a clickable relative link.
使用示例
查看来源仓库中的使用示例与配置说明。
查看来源 ↗来源历史
- 收录时间
- 2026-01-20
- 索引更新时间
- 2026-01-26
- Branch
- main
收录与同步日期属于本站记录。源码修改历史请查看来源仓库。
GitHub ↗chat Comments (0)
Sign in to join the discussion and leave a comment.
No comments yet. Be the first to share your thoughts!