dev-guide-generator

Featured

Generates complete technical tutorials from prerequisites and environment setup to core steps, troubleshooting, and a final cheatsheet. Trigger on requests to write a tutorial, create a setup guide, organize steps for beginners, or keywords like step-by-step, quickstart, or how-to guide.

AI & Automation 4,441 stars 447 forks Updated 2 days ago MIT

Install

View on GitHub

Quality Score: 96/100

Stars 20%
100
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# Dev Guide Generator **One topic → complete technical tutorial**: Through a structured SOP workflow, transform a technical topic into a comprehensive tutorial covering prerequisites, environment setup, core steps, common error troubleshooting, and advanced topics — all accompanied by a cheatsheet. ## Quick Start The user simply provides a technical topic or operational goal, and the Agent automatically generates a complete tutorial following this workflow: ``` User: Help me write a Docker beginner's tutorial Agent: [Outputs complete technical tutorial + Cheatsheet following the SOP workflow] ``` ## SOP Workflow ### Phase 1: Topic Scoping & Audience Analysis **Goal**: Define the tutorial's technical subject, target audience, and scope boundaries. **Steps**: 1. **Parse the topic**: Identify the core technology, operational goals, and expected deliverables from the user's input 2. **Ask clarifying questions** (up to 4 key questions): - What is the target audience's technical level? (Complete beginner / Some experience / Experienced developer) - What operating system will the reader be using? (macOS / Windows / Linux / Any) - What should the reader be able to do after completing the tutorial? (Specific deliverable) - Are there any version or tech stack constraints? 3. **If the user asks to skip clarification**, proceed with these default assumptions: - Audience: Has basic programming experience but is unfamiliar with the topic technology - Environment:...

Details

Author
zebbern
Repository
zebbern/claude-code-guide
Created
1 years ago
Last Updated
2 days ago
Language
Python
License
MIT

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category