tech-tutorial

Solid

Plan, draft, and refine technical tutorials for developers.

Code & Development 310 stars 27 forks Updated today MIT

Install

View on GitHub

Quality Score: 94/100

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

Skill Content

# Tech Tutorial A good technical tutorial has one goal: move a reader from not knowing how to do something to being able to do it. That requires working code, concrete steps, and honest acknowledgment of where things go wrong. This skill guides you through outlining, drafting, and verifying a tutorial that meets that standard. ## When To Use - Writing a getting-started guide for a library, CLI tool, or API - Creating a step-by-step walkthrough that readers follow at a terminal - Explaining a technical concept through a hands-on exercise - Producing a how-to that complements API reference documentation ## When NOT To Use - Generating API reference docs (use `scribe:doc-generator`) - Cleaning up existing prose (use `scribe:slop-detector`) - Producing high-level architecture overviews without runnable steps - Writing conceptual essays without hands-on components ## Methodology ### Step 1: Scope and Audience Before writing a single line, answer these questions: - Who is this for? (experience level, assumed prior knowledge) - What will they build or accomplish by the end? - What is the single prerequisite the reader must have installed? - What is explicitly out of scope? Write these answers down as a header block in the draft. If you cannot answer the "what will they accomplish" question in one sentence, the scope is too broad. ### Step 2: Outline Load: `@modules/outline-structure.md` Produce a section-by-section outline before drafting prose. Each section entry must ...

Details

Author
athola
Repository
athola/claude-night-market
Created
6 months ago
Last Updated
today
Language
Python
License
MIT

Bundled in these plugins

Similar Skills

Semantically similar based on skill content — not just same category