Create a Beginner Tutorial
Create a beginner-friendly tutorial for: $ARGUMENTS
It needs to be focused, hands-on, and succinct. Design a minimal set of hands-on activities through a demo project so that users can follow just to get the main idea. It is not a comprehensive tutorial. It is an introduction to a topic for completely new users.
Keep it short. Aim for ~400 lines or less. Remove unnecessary explanations.
Phase 1: Research
Search the web first to get the most current information:
- Latest version numbers and download links
- Current best practices and recommended approaches
- Up-to-date installation methods
Phase 2: Get User Input
Before writing the tutorial, present a brief plan to the user:
- Summarize what you learned from research (2-3 bullet points)
- If multiple approaches exist, recommend ONE simplest option for beginners
- List the major steps you plan to include (5-10 items)
- Ask: “Does this approach work for you, or would you prefer a different option?”
Wait for user approval before proceeding to Phase 3.
Iterate with user - they may request changes to the plan. Update accordingly.
Phase 3: Write the Tutorial
Structure
-
Home Link - Add
[Home](./)at the very top of the file (before the title) -
Title - Clear, descriptive (e.g., “Installing Claude Code on Windows Using WSL”)
- Hook (one paragraph, 2-4 sentences)
- Combine: problem scenario + simple analogy + why this matters
- Keep it compact, not multiple paragraphs
- Key Concepts (3-4 terms max)
- Use bullet list format for compact spacing:
- **Term** - explanation - One sentence per concept
- Use bullet list format for compact spacing:
-
What You’ll Need - Prerequisites (3-5 items), the last item is the required time such as 15-20 minutes.
- Step-by-Step Instructions
- Format:
## Step N: Action Verb + What - Use bullet points for sub-steps (not numbered lists) to avoid confusion with step numbers
- Exact actions: “Click Button Name” or “Type
command” - Code blocks for commands
- Remove introductory sentences at the beginning of steps unless essential
- Remove ending sentences after steps unless they provide critical information
- Avoid keyboard shortcuts unless essential or very convenient - use menu-based instructions instead (e.g., “Click File > Save” instead of “Press Ctrl+S”)
- For essential shortcuts (like running code), include both platforms:
Ctrl+Enter(Windows/Linux) orCmd+Enter(Mac)
- Format:
-
Next Steps - What to try next using this setup to learn on your own(2-3 examples)
-
Troubleshooting - Use bullet list format, 2-3 most common issues with one-line solutions
- Workflow overview - Summary of the workflow / tech stack (optional). 3-5 bullet points.
Formatting Rules
Use bullet lists for compact spacing:
- Key Concepts, Troubleshooting, and similar sections should use bullet lists
- This keeps related items visually grouped without excessive blank lines
Avoid numbered list confusion:
- Steps use numbers in headings: Step 1, Step 2, Step 3…
- Sub-steps within each step use bullets (-) not numbers
- This creates clear visual hierarchy
Be concise:
- Short paragraphs (2-3 sentences max)
- Bullet points over prose
- Remove introductory and ending sentences from steps unless essential
- No “What You’ve Learned” sections
Code examples:
- Keep code simple - use built-in datasets or minimal examples
- Avoid complex concepts (regression, advanced statistics, etc.) unless that’s the tutorial’s focus
- Focus on demonstrating the tool/workflow, not teaching programming concepts
Be explicit for beginners:
- Describe exactly what to click (e.g., “Click the gear icon in the lower left corner, then select Settings”)
- Use menu-based instructions instead of keyboard shortcuts (e.g., “Click File > Save” not “Press Ctrl+S”)
- Tell them what they’ll see (briefly)
- Never assume prior knowledge
- Avoid jargon
Format for scanning:
- Headers to break up sections
- Code blocks for all commands
- Bold for UI elements: Button Name
- Backticks for commands:
command here
Add links inline:
- Link tool names to official sites on first mention
- No separate “Sources” section
Add creation date at the very end: “Created by Steven Ge on [date].”
Output
Save the tutorial in the docs/ folder with a descriptive filename:
- Pattern:
Install_TOOLNAME_PLATFORM.mdorTOPIC_Guide.md - Examples:
docs/Install_Docker_Mac.md,docs/Git_Basics_Guide.md