deepinit skill
Analyzes codebases to generate structured documentation including READMEs, architecture diagrams, API specifications, and changelogs.
- GitHub stars
- 9
- Files
- 1
- Last commit
- Nov 7, 2026
- License
- MIT
- Allowed tools
- —
What does the deepinit skill do?
deepinit analyzes codebases to generate structured documentation including READMEs, architecture diagrams, API specifications, and changelogs.
Summary generated from the skill's SKILL.md.
About the deepinit skill
Generating structured technical documentation from existing codebases is the primary function of deepinit. Developers use this skill to transform raw source code into organized README files, architecture diagrams, API specifications, and changelogs. When an agent receives commands like '/deepinit' or 'generate docs', it initiates a multi-step workflow that begins by asking the user to select a documentation scope, such as a single document type or a full suite of files.
The process relies on an explorer tool to map the project structure, identify the tech stack, and detect entry points or models. A writer tool then produces the actual content, including Mermaid syntax for component diagrams and data flow visualizations. For users requesting the full suite, a code-reviewer tool verifies that the documentation accuracy matches the actual code and ensures all major features are covered before presenting the final list of files.
Written from the skill's SKILL.md. Every use case is checked against a quote from it.
How to install the deepinit skill
Each command copies the skill folder into the client's skills directory. Restart the client or start a new session to load it.Install the deepinit skill in Plugin
/plugin marketplace add johnfkoo951/cmdspace-plugins /plugin install dev-orchestrator@cmdspace-plugins
Install the deepinit skill in Claude Code
~/.claude/skills/deepinit/SKILL.md
$ npx degit johnfkoo951/cmdspace-plugins/plugins/dev-orchestrator/skills/deepinit ~/.claude/skills/deepinitInstall the deepinit skill in Claude Code (project)
.claude/skills/deepinit/SKILL.md
$ npx degit johnfkoo951/cmdspace-plugins/plugins/dev-orchestrator/skills/deepinit .claude/skills/deepinitInstall the deepinit skill in Codex
~/.agents/skills/deepinit/SKILL.md
$ npx degit johnfkoo951/cmdspace-plugins/plugins/dev-orchestrator/skills/deepinit ~/.agents/skills/deepinitInstall the deepinit skill in Gemini CLI
~/.gemini/skills/deepinit/SKILL.md
$ npx degit johnfkoo951/cmdspace-plugins/plugins/dev-orchestrator/skills/deepinit ~/.gemini/skills/deepinitInstall the deepinit skill in Claude.ai
npx degit johnfkoo951/cmdspace-plugins/plugins/dev-orchestrator/skills/deepinit deepinit && zip -r deepinit.zip deepinit # claude.ai → Customize → Skills → + → Create skill → Upload a skill → deepinit.zip
SKILL.md
View on GitHubDeep Init — Hierarchical Documentation Generation
Analyzes the codebase and generates comprehensive, structured documentation.
Workflow
Step 1: Choose Documentation Scope
Use AskUserQuestion:
{
"questions": [
{
"question": "What documentation do you need?",
"header": "Docs Type",
"options": [
{"label": "README (Recommended)", "description": "Project overview, setup, usage, and contribution guide"},
{"label": "Architecture", "description": "System design, component diagrams, data flow documentation"},
{"label": "API docs", "description": "Endpoint specifications with request/response examples"},
{"label": "Full suite", "description": "README + Architecture + API docs + CHANGELOG"}
],
"multiSelect": false
}
]
}
Step 2: Analyze Codebase
Dispatch explorer (Haiku) to:
- Map complete project structure
- Identify tech stack, frameworks, and tools
- Find existing documentation (README, docs/, comments)
- Detect entry points, routes, models, and key abstractions
Step 3: Generate Documentation
Based on scope, dispatch writer (Haiku) with exploration results:
README: Project overview, installation, quickstart, configuration, features, contributing Architecture: Component diagram (Mermaid), data flow, key decisions, directory guide API docs: Endpoints, parameters, response schemas, examples, error codes CHANGELOG: Parse git log to generate structured changelog
For architecture diagrams, generate Mermaid syntax:
graph TB
subgraph Frontend
A[UI Components] --> B[State Management]
end
subgraph Backend
C[API Routes] --> D[Services]
D --> E[Database]
end
B --> C
Step 4: Review and Polish
If "Full suite" was selected, dispatch code-reviewer (Sonnet) to verify:
- Documentation accuracy (do code references match actual code?)
- Completeness (are all major features documented?)
- Clarity (would a new developer understand this?)
Step 5: Present Results
List all generated documentation files with a brief summary of each.
Files in this skill
1deepinit skill questions
How do I install the deepinit skill in Claude Code?
Run npx degit johnfkoo951/cmdspace-plugins/plugins/dev-orchestrator/skills/deepinit ~/.claude/skills/deepinit. Claude Code loads skills from ~/.claude/skills (all projects) or .claude/skills (one project) and uses a skill when its description matches the task.
Which clients can use the deepinit skill?
Any client that reads the Agent Skills format: Claude Code, Codex, Gemini CLI and claude.ai (upload as a ZIP). Scripts in the skill run only where the client allows code execution.
How are architecture diagrams created?
The tool generates Mermaid syntax to create component diagrams, data flows, and directory guides.
Does the tool verify the accuracy of the generated documentation?
Yes, if the full suite is selected, a code reviewer is dispatched to verify documentation accuracy, completeness, and clarity.