sovereign-codebase-onboarding
bởi ryudi84
Coding Agents & IDEsTóm tắt
Codebase onboarding assistant that maps project architecture, identifies patterns, generates guides, and helps new.
Mô tả
Kỹ năng này làm gì
Analyzes a repository's structure, architecture, and conventions through six phases: discovery, architecture mapping, pattern recognition, key file identification, guide generation, and interactive Q&A. Produces an annotated directory tree, ASCII architecture diagram, data flow traces, and a Day 1 checklist tailored to the specific project. Works on any language or stack.
Produces structured, actionable output (architecture diagrams, data flow traces, common task recipes, complexity ratings) rather than just summarizing README files or listing directory contents.
Khi nào nên dùng
- Onboarding a new hire to a large undocumented codebase
- Getting oriented in an open-source project before submitting a first PR
- Generating a handoff document before leaving a team
- Auditing a repository for tech debt and complexity hotspots
- Re-orienting to a codebase after an extended absence
Quy trình ví dụ
User asks: Can you onboard me to this repository?
- 1
Detects languages and frameworks from manifest files (package.json, go.mod, Cargo.toml, etc.)
- 2
Classifies the project type and identifies entry points and the boot sequence
- 3
Generates an annotated directory tree and ASCII architecture diagram
- 4
Traces primary data flows and identifies design patterns, naming conventions, and error handling style
- 5
Outputs a structured onboarding guide with a project-specific Day 1 checklist and common task recipes
A complete onboarding document covering architecture, key files, data flows, gotchas, tech debt hotspots, and copy-paste setup commands
Cài đặt
clawhub install ryudi84/sovereign-codebase-onboardingChạy lệnh CLI, hoặc dán prompt vào Claude Code, Cursor, Codex hay coding agent bạn đang dùng.