ClawKit Logo
ClawKitReliability Toolkit
Back to Registry
Official Verified

tech-tutorial

Plan, draft, and refine technical tutorials for developers

skill-install — Terminal

Install via CLI (Recommended)

clawhub install openclaw/skills/skills/athola/nm-scribe-tech-tutorial
Or

Night Market Skill — ported from claude-night-market/scribe. For the full experience with agents, hooks, and commands, install the Claude Code plugin.

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 include a one-line description of what the reader does or learns in that section. See the outline module for the standard section order and length targets per section type.

Step 3: Draft Code Examples First

Load: @modules/code-examples.md

Write the code before the prose. Each snippet must run against a real environment before it appears in the tutorial. Annotate only the non-obvious lines. See the code examples module for formatting and error-handling rules.

Step 4: Draft Prose Around the Code

Prose exists to explain what the code does and why. Follow these rules:

  • One paragraph per step: what to run, what it does, what to expect
  • State the expected output after each command block
  • Use second person ("you") consistently throughout
  • Do not narrate what the reader will do next; just present the next step

Step 5: Build Complexity Gradually

Load: @modules/progressive-complexity.md

Start with the minimal working example. Introduce variations and edge cases only after the baseline works. See the progressive complexity module for the layering rules and pacing guidance.

Step 6: Slop Check

After drafting, run:

Skill(scribe:slop-detector)

Fix all tier-1 findings before proceeding. Pay particular attention to:

Metadata

Author@athola
Stars4473
Views1
Updated2026-05-01
View Author Profile
AI Skill Finder

Not sure this is the right skill?

Describe what you want to build — we'll match you to the best skill from 16,000+ options.

Find the right skill
Add to Configuration

Paste this into your clawhub.json to enable this plugin.

{
  "plugins": {
    "official-athola-nm-scribe-tech-tutorial": {
      "enabled": true,
      "auto_update": true
    }
  }
}
Safety NoteClawKit audits metadata but not runtime behavior. Use with caution.