
项目概览生成skill
@user_055bebc4/project-overview-generator
By user_055bebc4
About this Skill
Analyzes any codebase (Go / JS / TS / Python / Java / Rust / etc.) or a single module/package within a codebase, and generates a thorough, illustrated overview document that helps newcomers ramp up fast. Use this skill when the user asks to "summarize this project/module", "analyze this codebase/package/directory", "explain this repo/folder", "write an overview for X", "help me understand this code/module", or provides any path (whole project root OR an inner directory) and wants a structured walkthrough. The skill auto-detects whether the target is a full project (has go.mod/package.json/etc.) or a sub-module inside a larger project, and adapts the output accordingly. For projects: produces {project-name}_overview.md at the project root with full 10-section layout. For modules: produces {module-name}_overview.md inside the module directory, focused on role, internal structure, core symbols, boundary (exported API / upstream callers / downstream deps), and how it plugs into the parent project. Guiding principle: completeness over brevity — scope size determines doc size.
Skill files and instructions
Read SKILL.md and the other instructions or configuration files published with this Skill.
Details
- Category
- Development
- Source
- Community
- Version
- 1.0.1
- Updated
- Sep 21, 2026