Tutorial Writer
tutorial-writer
Creates step-by-step tutorials with screenshot placeholders, code snippets, and troubleshooting sections. Use this skill when a user needs to write a how-to guide, help documentation, onboarding walkthrough, or educational tutorial for their product, tool, or process.
- This skill, packaged and ready to upload. tutorial-writer.zip
- In claude.ai or Claude desktop: Customize → Skills (+) → Create skill → Upload a skill, select the zip and toggle it on. Greyed out? Enable code execution under Settings → Capabilities.
- It’s live in your chats — no code, no setup. Want every Content skill at once? Add the whole plugin from the Content page (Customize → Personal plugins → Create plugin → Upload plugin).
/plugin marketplace add Salah-XD/equipt
/plugin install equipt-content Installs the whole equipt-content plugin — this skill included.
npx @equipt/cli init
npx @equipt/cli add tutorial-writer Adds just this skill to your Claude Code project.
When to Use This Skill
- User needs a how-to guide for their product or tool
- User wants to create help documentation or a knowledge base article
- User is building an onboarding walkthrough for new customers
- User needs a technical tutorial with code examples
- User wants to document a process with clear visual references
- User asks for educational content with step-by-step instructions
Core Principle
EVERY STEP MUST PASS THE "CAN I DO THIS RIGHT NOW?" TEST — IF A READER CANNOT TAKE IMMEDIATE ACTION FROM A STEP, THE STEP IS TOO VAGUE.
Workflow
Phase 1: Scope the Tutorial
- Identify the tutorial topic and target reader skill level (beginner, intermediate, advanced)
- Define the single outcome the reader will achieve by the end
- List prerequisites the reader needs before starting
- Estimate completion time for the full tutorial
Ask the user:
- What is the reader trying to accomplish?
- What do they already know coming in?
- What tool/platform/language is involved?
Phase 2: Outline the Steps
- Break the process into 5-12 major steps (fewer for beginners, more granularity is fine for advanced)
- Order steps chronologically — never jump ahead or reference future steps
- Identify where screenshots or visuals would help (mark with
[SCREENSHOT: description]) - Note any decision points where the reader might take different paths
Phase 3: Write Each Step
Write each step using this structure:
- Step title as a heading (action verb + object)
- One sentence explaining WHY this step matters
- Numbered sub-steps with exact UI paths or commands
- Screenshot placeholder where the reader needs visual confirmation
- Expected result after completing the step
- Common mistake callout if applicable
For code snippets, always include:
- The complete code block (not fragments)
- Language identifier on the code fence
- Inline comments explaining non-obvious lines
- Expected output or result
Phase 4: Add Troubleshooting
Create a "Troubleshooting" section at the end covering:
- 3-5 most common errors or confusion points
- Exact error messages the reader might see
- Step-by-step fix for each issue
- "If this doesn't work" escalation path
Add a "What's Next" section linking to logical follow-up tutorials or resources
Phase 5: Format and Polish
- Add a title, estimated time, difficulty level, and prerequisites at the top
- Ensure every screenshot placeholder has a descriptive label
- Add tip/warning/note callouts using blockquote formatting
- Review for jargon — replace or define any term a beginner wouldn't know
Output Format
# How to [Achieve Specific Outcome]
**Difficulty:** Beginner | Intermediate | Advanced
**Time:** X minutes
**Prerequisites:** [List what's needed]
---
## Step 1: [Action Verb] + [Object]
Why this matters: [one sentence].
1. Go to **Settings > Account > API Keys**
2. Click **Generate New Key**
3. Name your key `production-api`
[SCREENSHOT: The API Keys panel showing the Generate New Key button]
**Expected result:** You see a new key starting with `sk-` in your key list.
> **Common mistake:** Don't copy the key ID — copy the full key value that starts with `sk-`.
---
## Troubleshooting
### "Invalid API Key" error
1. Confirm you copied the full key (starts with `sk-`)
2. Check there are no trailing spaces
3. Regenerate the key if the issue persists
---
## What's Next
- [Link to next tutorial]
Example 1: Setting Up Stripe Payments in Shopify
Input: "Write a tutorial for adding Stripe to a Shopify store"
Output:
How to Connect Stripe Payments to Your Shopify Store
Difficulty: Beginner Time: 15 minutes Prerequisites: Active Shopify store, Stripe account (free to create)
Step 1: Create Your Stripe Account
Why this matters: Stripe processes your credit card payments and deposits funds to your bank.
- Go to stripe.com and click Start now
- Enter your email, full name, and create a password
- Click Create account
[SCREENSHOT: Stripe signup page with the three fields highlighted]
Expected result: You land on the Stripe Dashboard with a banner saying "Welcome to Stripe."
Step 2: Activate Stripe in Shopify
Why this matters: This links your Stripe account to your store so payments flow correctly.
- In Shopify admin, go to Settings > Payments
- Under "Payment providers," click Choose a provider
- Select Stripe from the list
- Click Activate Stripe
- Log in with your Stripe credentials when prompted
[SCREENSHOT: Shopify Payments settings page with Stripe listed under providers]
Expected result: Stripe appears as your active payment provider with a green "Active" badge.
Warning: If you already have Shopify Payments active, you must deactivate it first. Go to Settings > Payments > Manage > Deactivate Shopify Payments.
Step 3: Run a Test Transaction
Why this matters: Confirms payments actually work before real customers try to buy.
- In Stripe Dashboard, toggle Test mode (top right)
- In Shopify, go to Settings > Payments > Manage
- Check Enable test mode
- Place an order on your store using test card
4242 4242 4242 4242, any future expiration, any CVC - Confirm the order appears in Stripe Dashboard under Payments
[SCREENSHOT: Stripe Dashboard showing the test payment with "Succeeded" status]
Expected result: The test payment shows "Succeeded" in Stripe and the order appears in Shopify.
Tip: Always disable test mode before going live. Real customers cannot pay while test mode is on.
Troubleshooting
"Connection failed" when activating Stripe
- Clear your browser cache and cookies
- Try in an incognito/private browser window
- Ensure your Stripe account email matches your login
- If the issue persists, contact Shopify support at Help > Contact Support
Test payment shows "Failed"
- Confirm you used test card number
4242 4242 4242 4242 - Ensure test mode is enabled in BOTH Stripe and Shopify
- Check that the expiration date is in the future
Payments not appearing in bank account
- Stripe holds first payouts for 7-14 days (normal for new accounts)
- Go to Stripe Dashboard > Payouts to see your payout schedule
- Ensure your bank account is verified under Settings > Bank accounts
What's Next
- Set up automatic tax calculation in Shopify
- Configure shipping rates for your store
- Create your first discount code
Example 2: Creating a Mailchimp Email Automation
Input: "Tutorial for setting up a welcome email sequence in Mailchimp"
Output:
How to Create a Welcome Email Sequence in Mailchimp
Difficulty: Intermediate Time: 30 minutes Prerequisites: Mailchimp account (Standard plan or higher), at least one audience/list
Step 1: Navigate to Automations
- Log in to Mailchimp and click Automations in the left sidebar
- Click Create Automation
- Select Welcome new subscribers
- Choose your audience from the dropdown
- Click Begin
[SCREENSHOT: Mailchimp automation builder showing the "Welcome new subscribers" template selected]
Expected result: You see the automation builder with one email pre-loaded.
Step 2: Configure Email 1 — The Instant Welcome
- Click on Email 1 in the automation flow
- Set the trigger to Immediately after signup
- Set the subject line:
Welcome to the crew — here's what to expect - Click Design Email and choose a template
- Write your welcome content: introduce yourself, set expectations for email frequency, deliver any promised lead magnet
- Click Save and Continue
[SCREENSHOT: Email editor with subject line and body content filled in]
Expected result: Email 1 shows a green checkmark in the automation flow.
Step 3: Add Email 2 — The Value Email (Day 3)
- Click Add Email below Email 1
- Set the delay to 3 days after the previous email
- Subject line:
The #1 mistake I see new store owners make - Write content that delivers genuine value — a tip, framework, or resource
- Click Save and Continue
[SCREENSHOT: Delay settings showing "3 days after previous email"]
Step 4: Add Email 3 — The Soft Ask (Day 7)
- Click Add Email below Email 2
- Set the delay to 4 days after the previous email
- Subject line:
Quick question for you - Write content that invites a reply or introduces your product/service naturally
- Click Save and Continue
Step 5: Activate the Automation
- Review all three emails in the flow view
- Click Start Sending in the top right
- Confirm in the popup dialog
Warning: Once activated, you cannot reorder emails. You can edit content and pause individual emails, but the sequence order is locked.
[SCREENSHOT: Completed automation flow showing all three emails with green checkmarks]
Expected result: The automation status changes to "Sending" and new subscribers will receive the sequence.
Troubleshooting
Subscribers not receiving the welcome email
- Check if the automation is set to "Sending" (not "Paused")
- Verify the subscriber joined the correct audience
- Go to Audience > All contacts and check if the contact shows as "Subscribed" (not "Cleaned" or "Unsubscribed")
Emails landing in spam
- Authenticate your domain: go to Website > Domains > Authenticate
- Remove spam trigger words from subject lines (FREE, ACT NOW, etc.)
- Ensure you have a physical mailing address in your email footer
Cannot add more than 3 emails
- Confirm you are on Mailchimp Standard plan or higher
- Free and Essentials plans limit automation emails
What's Next
- Set up abandoned cart email automation
- Create a re-engagement sequence for inactive subscribers
- Build a post-purchase follow-up automation
Recovery and Fallback
- If the user's topic is too broad, narrow it: "Let's focus on just the setup portion first. We can create a separate tutorial for advanced configuration."
- If the process has more than 15 steps, split into a multi-part series with clear links between parts
- If the user cannot provide screenshots, describe the exact UI location in text: "the blue button labeled 'Save' in the top-right corner of the page"
- If the user's tool has no public documentation, ask for a screen recording or live walkthrough to extract the steps
- After 3 failed attempts to clarify the process, stop and say: "I need more context about how this feature works. Can you walk me through it once so I can document it?"
Constraints
- NEVER skip the troubleshooting section — every tutorial must have at least 3 common issues
- NEVER use vague instructions like "configure the settings" — name every button, field, and menu path
- NEVER assume the reader knows keyboard shortcuts — always provide the menu path first
- Keep each step to ONE action — if you write "and then," it should be two steps
- Screenshot placeholders must describe WHAT the reader should see, not just WHERE to look
- All code blocks must include the language identifier for syntax highlighting
- Do not exceed 20 major steps — split into multiple tutorials if needed
- Total output must stay under 500 lines