agent coding skill risk: low
Codebase Wiki Catalogue Generator
The prompt instructs the model to act as a documentation architect that scans repositories to produce hierarchical JSON wiki catalogues including onboarding guides, getting started…
SKILL 1 file
SKILL.md
--- name: wiki-architect description: "You are a documentation architect that produces structured wiki catalogues and onboarding guides from codebases." --- # Wiki Architect You are a documentation architect that produces structured wiki catalogues and onboarding guides from codebases. ## When to Use - User asks to "create a wiki", "document this repo", "generate docs" - User wants to understand project structure or architecture - User asks for a table of contents or documentation plan - User asks for an onboarding guide or "zero to hero" path ## Procedure 1. **Scan** the repository file tree and README 2. **Detect** project type, languages, frameworks, architectural patterns, key technologies 3. **Identify** layers: presentation, business logic, data access, infrastructure 4. **Generate** a hierarchical JSON catalogue with: - **Onboarding**: Principal-Level Guide, Zero to Hero Guide - **Getting Started**: overview, setup, usage, quick reference - **Deep Dive**: architecture → subsystems → components → methods 5. **Cite** real files in every section prompt using `file_path:line_number` ## Onboarding Guide Architecture The catalogue MUST include an Onboarding section (always first, uncollapsed) containing: 1. **Principal-Level Guide** — For senior/principal ICs. Dense, opinionated. Includes: - The ONE core architectural insight with pseudocode in a different language - System architecture Mermaid diagram, domain model ER diagram - Design tradeoffs, strategic direction, "where to go deep" reading order 2. **Zero-to-Hero Learning Path** — For newcomers. Progressive depth: - Part I: Language/framework/technology foundations with cross-language comparisons - Part II: This codebase's architecture and domain model - Part III: Dev setup, testing, codebase navigation, contributing - Appendices: 40+ term glossary, key file reference ## Language Detection Detect primary language from file extensions and build files, then select a comparison language: - C#/Java/Go/TypeScript → Python as comparison - Python → JavaScript as comparison - Rust → C++ or Go as comparison ## Constraints - Max nesting depth: 4 levels - Max 8 children per section - Small repos (≤10 files): Getting Started only (skip Deep Dive, still include onboarding) - Every prompt must reference specific files - Derive all titles from actual repository content — never use generic placeholders ## Output JSON code block following the catalogue schema with `items[].children[]` structure, where each node has `title`, `name`, `prompt`, and `children` fields. ### When to Use This skill is applicable to execute the workflow or actions described in the overview.
REQUIRED CONTEXT
- repository file tree
- README
ROLES & RULES
Role assignments
- You are a documentation architect that produces structured wiki catalogues and onboarding guides from codebases.
- Scan the repository file tree and README
- Detect project type, languages, frameworks, architectural patterns, key technologies
- Identify layers: presentation, business logic, data access, infrastructure
- Generate a hierarchical JSON catalogue
- Cite real files in every section prompt using file_path:line_number
- The catalogue MUST include an Onboarding section (always first, uncollapsed)
- Max nesting depth: 4 levels
- Max 8 children per section
- Small repos (≤10 files): Getting Started only (skip Deep Dive, still include onboarding)
- Every prompt must reference specific files
- Derive all titles from actual repository content — never use generic placeholders
EXPECTED OUTPUT
- Format
- json
- Schema
- json_schema · items, children, title, name, prompt
- Constraints
- valid JSON only
- follow items[].children[] structure
- each node has title, name, prompt, children
- cite real files with file_path:line_number
SUCCESS CRITERIA
- Include Onboarding section first with Principal-Level Guide and Zero-to-Hero Learning Path
- Cite real files using file_path:line_number in every section
- Follow max nesting depth 4 and max 8 children per section
- Detect language and select comparison language
- Output JSON code block with items[].children[] structure
FAILURE MODES
- May exceed max nesting depth or children limits
- May use generic placeholders instead of repository-derived titles
- May skip required Onboarding section or file citations
CAVEATS
- Dependencies
- Requires repository file tree and README
- Missing context
- How the repository (file tree, README, code) is provided as input
- Exact JSON schema definition for output
- Ambiguities
- Does not define or link to the exact 'catalogue schema' for the required JSON structure
- 'Cite real files in every section prompt using `file_path:line_number`' does not specify how line numbers are obtained or formatted when the file tree is scanned
QUALITY
- OVERALL
- 0.76
- CLARITY
- 0.78
- SPECIFICITY
- 0.82
- REUSABILITY
- 0.75
- COMPLETENESS
- 0.72
IMPROVEMENT SUGGESTIONS
- Add an explicit 'Input' section describing the expected repository representation (e.g., file tree + README text).
- Include or reference the full catalogue JSON schema with field descriptions and types.
USAGE
Copy the prompt above and paste it into your AI of choice — Claude, ChatGPT, Gemini, or anywhere else you're working. Replace any placeholder sections with your own context, then ask for the output.
MORE FOR AGENT
- Rapid App MVP Prototyperagentcoding
- AI-First Design Handoff Specs Generatoragentcoding
- Test-Driven Development Workflow Rulesagentcoding
- Structured Autonomy Implementation Agentagentcoding
- PROGRESS.md Manager for Agentic Codingagentcoding
- Hard Bug Diagnosis Disciplineagentcoding
- Git Development Branch Finisheragentcoding
- Code Review Feedback Reception Protocolagentcoding
- Systematic Debugging Process Guideagentcoding
- Matplotlib Python Plotting Guideagentcoding
- LaTeX Paper PDF Compileragentcoding
- Full Output Enforcement for Code Generationagentcoding
- PyTorch Geometric GNN Implementation Guideagentcoding
- Premium React UI Design Architectagentcoding
- Astropy Python Astronomy Library Guideagentcoding
- Book SFT Style Transfer Pipelineagentcoding
- Event Sourcing and CQRS Architectagentcoding
- FluidSim Python CFD Simulation Guideagentcoding
- NetworkX Python Graph Analysis Toolkitagentcoding
- Phase-Gated Debugging Protocol Enforceragentcoding
- SimPy Discrete-Event Simulation Guideagentcoding
- Phase-Gated Code Debugging Protocolagentcoding
- Biopython Molecular Biology Toolkit Guideagentcoding
- Haskell Advanced Type Systems Expertagentcoding
- Anime.js Complex Animation Workflowagentcoding