Write a step-by-step code tutorial
Writes a technical tutorial a reader can follow end to end, with pinned prerequisites, complete runnable snippets and a checkpoint after every step. Use for docs, blog tutorials or workshop material.
A tutorial is learning by doing: the reader follows steps and ends with something that works. It fails when a snippet elides a line the reader needs, when versions drift and an API no longer exists, when a step depends on a file the text never created, or when the reader cannot tell whether they are still on track. A good tutorial shows the destination first, keeps the project runnable after every step, and gives the reader a checkpoint they can compare against.
Write a tutorial on: Reader level: . Only if [STACK] is given: Stack: . If no stack is given and the topic does not imply one, ask which to use before writing; if it is implied, state the stack and versions you chose.
- Define the outcome in one or two sentences and show it (final output, screenshot description or a short demo of the finished program).
- List prerequisites: tools with minimum versions, accounts or keys, and the knowledge you assume for this reader level. Show how to check each version.
- Plan 5 to 10 steps. Each step adds one concept and leaves the project in a runnable state.
- For each step:
- a heading that says what the reader does;
- why this step exists, in one or two sentences;
- complete code with the file path above each block; when a file changes, show the whole file if it is short, or the full function with a clear "replace this function" instruction if long; never "..." inside code the reader must run;
- the command to run;
- a checkpoint: the exact output or behaviour to expect;
- "If it does not work": the most likely mistake at this step and how to fix it.
- End with the complete final code (or the file tree plus each file), what to try next, and links only to official documentation you are confident exists.
- Adjust depth to the level: beginners get each command and term explained; experts get the reasoning and trade-offs and skip the basics.
- Use only APIs that exist in the stated versions. Where you are unsure an API or flag exists in that version, say so in the Author checklist rather than presenting it as certain.
- Pin versions in install commands. No secrets in code; read them from environment variables and show how to set them.
- Each concept is introduced before it is used. Do not add features the outcome does not need.
Tutorial
The tutorial in Markdown: title, outcome, prerequisites, numbered steps as described, final code, next steps.
Author checklist
Bullets for the author to verify before publishing: every API or version claim you are not certain of, every command to run end to end on a clean machine, and any screenshot to capture.
1 required value still a placeholder; the assistant will ask for it.
details
- kind
- Prompt: a task you run by name to get one finished thing back
- domain
- Software engineering
- category
- Documentation
- level
- Intermediate
- made for
- Technical writer, Developer advocate, Software engineer, Teacher / tutor
- risk
- read-only
- version
- v1.0.0 · incubating
- reviewed
- 2026-10-02
- works in
- Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, Antigravity, OpenCode, Windsurf, Zed, Continue, AGENTS.md, ChatGPT, claude.ai
use in
npx @hermes-hq/hodios install write-code-tutorial --target claude-codenpx skills add hermes-hq/hodios-dist --skill write-code-tutorial -a claude-codeclaude plugin marketplace add hermes-hq/hodios-distclaude plugin install hodios-software-engineering@hodiosThe plugin brings every entry in this domain at once.
pairs well with
All of DocumentationTechnical writer
Writes and edits developer documentation that is accurate to the code, task-oriented and easy to scan. Use as the voice for READMEs, API references, guides and changelogs.
technical-writerDocument a public API
Writes reference docs for a module's exported functions, classes or endpoints in the native doc-comment format, covering real behaviour, errors and edge cases. Use before a release.
document-public-apiWrite a changelog entry
Turns the commits and pull requests in a release range into a user-facing changelog entry in Keep a Changelog format, with breaking changes first. Use when cutting a release.
write-changelogWrite a migration guide
Writes an upgrade guide for a breaking release that lists each breaking change with how to find affected code, before-and-after examples and a way to verify. Use when shipping a major version.
write-migration-guideWrite a README
Writes or improves a project README from what the code actually does, with an install and quick start that work when copied. Use for a new project or a README that has drifted.
write-readmeAudit a documentation set
Audits documentation for accuracy against the code, gaps in the user journey, stale pages, duplication and findability, and returns a prioritised fix list. Use before a docs overhaul or release.
audit-documentation