✍️ Technical Writing · API Reference & Guides
Write tutorials people actually finish
Fast first win, verifiable checkpoints, and failure exits keeping momentum.
intermediate~35 minTechnical WritersDeveloper AdvocatesEngineers Who Document
Steps
- 1Promise specific outcome in title; deliver it under 15 minutes
- 2Show expected result early with screenshot of finished state
- 3Verify-everything: each step includes what user should see
- 4Number recovery paths for common failures inline
- 5Cut every sentence not moving toward the promised outcome
- 6Test with two fresh users watching silently; fix stumbles
Common Pitfalls
- ▲Prerequisite walls before first success
- ▲'Simply' doing invisible multi-step things
Commands
Install with skills CLI
$ npx skills add aniruddhaadak80/skills --skill api-reference-tutorial-craftInstall globally
$ npx skills add aniruddhaadak80/skills --skill api-reference-tutorial-craft -gTags
#tutorials#onboarding#dx#technical-writing#api-reference