tutorial
Creates step-by-step technical tutorials with progressive disclosure: shows the end state first, builds through working checkpoints, and explains what just happened after each one. Make sure to use this skill whenever the user says "create a tutorial", "step-by-step guide", "onboarding guide", "teach me how to", "how do I learn X", or runs /tutorial. Also triggers when someone needs to write documentation that teaches a skill rather than just describing an API — even if they don't use the word "tutorial".
What this skill does
# Tutorial Writer Tutorials fail when they front-load theory or hide the result until the end. This structure builds toward a visible goal with checkpoints that confirm understanding along the way. ## Structure (non-negotiable order) ### 1. Show the End State First Before any steps, show what the reader will have built when they're done. A screenshot, a code snippet output, a running demo. This creates a goal — readers tolerate confusion when they can see where it's going. ``` By the end of this tutorial, you'll have: [concrete, visible result — not "understand X" but "a working Y that does Z"] ``` ### 2. Prerequisites What the reader needs to already know or have installed. Be specific: - "Node.js 18+" not "Node.js" - "Familiarity with async/await" not "JavaScript experience" - Link to setup instructions for tools, don't include them inline ### 3. Steps in Order of Dependency Each step does one thing and builds on the previous step. Never skip a step because it "should be obvious" — if it were obvious, there would be no need for a tutorial. **Each step structure:** ``` ## Step N: [Action verb + what] [1-2 sentences of context — why this step exists] [Code block or command to run] [Expected output or visible result] ``` ### 4. Working Checkpoint After Each Major Step Every 2-4 steps, include a checkpoint: the reader should run something and see a result that confirms they're on track. If they can't, they know exactly where they got lost. ``` ### Checkpoint Run: [command] You should see: [exact expected output] If you see X instead, [specific fix]. ``` ### 5. "What Just Happened?" After Each Checkpoint A brief explanation of the mechanism — not re-explaining the steps, but the underlying concept. This is what turns a recipe-follower into someone who understands the system. Keep it short: 3-5 sentences. Long explanations belong in concept docs, not tutorials. ### 6. Extension Exercises After the tutorial is complete, 2-3 things to try next. These extend the tutorial naturally rather than pointing at unrelated docs. Format: "Try X to see what happens when Y." ## Writing Rules **Every code block must:** - Be copy-pasteable without modification (no `<your-value>` placeholders without explaining how to get the value) - Show exactly what to run and where (file path matters) - Include the full context needed to understand it, not just the interesting line **Errors the reader will hit:** Include the 2-3 most common errors with exact error messages and fixes. Don't ignore the unhappy path — it's where most readers abandon the tutorial. **Words to never use:** - "simple" / "simply" / "easy" / "just" — if it were, they wouldn't need a tutorial - "obviously" / "of course" — condescending - "as you can see" — if the code needs narrating, the code isn't clear ## Workflow 1. Clarify the topic and target audience (what do they already know?) 2. Identify the end state — what working thing will they have built? 3. Map the dependency order of steps before writing any of them 4. Write with checkpoints every 2-4 steps 5. Test each code block mentally or actually run it — tutorials with broken code destroy trust immediately ## Output A complete tutorial with: - End state shown upfront - Prerequisites list - Numbered steps with code blocks - Working checkpoints with expected output - "What just happened?" after each checkpoint - Common errors section - Extension exercises
Related in Backend & APIs
jfrog
IncludedInteract with the JFrog Platform via the JFrog CLI and REST/GraphQL APIs. Use this skill when the user wants to manage Artifactory repositories, upload or download artifacts, manage builds, configure permissions, manage users and groups, work with access tokens, configure JFrog CLI servers, search artifacts, manage properties, set up replication, manage JFrog Projects, run security audits or scans, look up CVE details, query exposures scan results from JFrog Advanced Security, manage release bundles and lifecycle operations, aggregate or export platform data, or perform any JFrog Platform administration task. Also use when the user mentions jf, jfrog, artifactory, xray, distribution, evidence, apptrust, onemodel, graphql, workers, mission control, curation, advanced security, exposures, or any JFrog product name.
cupynumeric-migration-readiness
IncludedPre-migration readiness assessor for porting NumPy to cuPyNumeric. Use BEFORE substantial porting work begins when the user asks whether code will scale on GPU, whether they should migrate to cuPyNumeric, which NumPy patterns transfer cleanly, what must be refactored before porting, or mentions pre-port assessment, scaling analysis, or refactor planning. Inspect the user's source code, look up NumPy usage, cross-reference the cuPyNumeric API support manifest, and distinguish distributed-scaling-friendly patterns from blockers such as unsupported APIs, scalar synchronization, host round-trips, Python/object-heavy control flow, shape/data-dependent branching, and in-place mutation hazards. Produce a verdict of READY, LIGHT REFACTOR, SIGNIFICANT REFACTOR, or NOT RECOMMENDED, with concrete refactor pointers.
alibabacloud-data-agent-skill
IncludedInvoke Alibaba Cloud Apsara Data Agent for Analytics via CLI to perform natural language-driven data analysis on enterprise databases. Data Agent for Analytics is an intelligent data analysis agent developed by Alibaba Cloud Database team for enterprise users. It automatically completes requirement analysis, data understanding, analysis insights, and report generation based on natural language descriptions. This tool supports: discovering data resources (instances/databases/tables) managed in DMS, initiating query or deep analysis sessions, real-time progress tracking, and retrieving analysis conclusions and generated reports. Use this Skill when users need to query databases, analyze data trends, generate data reports, ask questions in natural language, or mention "Data Agent", "data analysis", "database query", "SQL analysis", "data insights".
token-optimizer
IncludedReduce OpenClaw token usage and API costs through smart model routing, heartbeat optimization, budget tracking, and native 2026.2.15 features (session pruning, bootstrap size limits, cache TTL alignment). Use when token costs are high, API rate limits are being hit, or hosting multiple agents at scale. The 4 executable scripts (context_optimizer, model_router, heartbeat_optimizer, token_tracker) are local-only — no network requests, no subprocess calls, no system modifications. Reference files (PROVIDERS.md, config-patches.json) document optional multi-provider strategies that require external API keys and network access if you choose to use them. See SECURITY.md for full breakdown.
resend-cli
IncludedUse this skill when the task is specifically about operating Resend from an AI agent, terminal session, or CI job via the official resend CLI: installing/authenticating the CLI, sending/listing/updating/cancelling emails, batch sends, domains and DNS, webhooks and local listeners, inbound receiving, contacts, topics, segments, broadcasts, templates, API keys, profiles, or debugging Resend CLI/API failures. Trigger on mentions of Resend CLI, `resend`, `resend doctor`, `resend emails send`, `resend domains`, `resend webhooks listen`, `resend emails receiving`, or agent-friendly terminal automation.
alibabacloud-odps-maxframe-coding
IncludedUse this skill for MaxFrame SDK development and documentation navigation on Alibaba Cloud MaxCompute (ODPS). Helps answer MaxFrame API, concept, official example, and supported pandas API questions; create data processing programs; read/write MaxCompute tables; debug jobs (remote or local); and build custom DPE runtime images. Trigger when users mention MaxFrame, MaxCompute with MaxFrame, ODPS table processing, DPE runtime, MaxFrame docs/examples, DataFrame/Tensor operations, or GPU runtime setup. Works for both English and Chinese queries about Alibaba Cloud data processing with MaxFrame.