What Are Codelabs?
Codelabs are interactive, self-paced tutorials that guide learners through a topic using real code, terminal environments, and structured steps. Unlike static documentation, codelabs give learners a chance to do the thing, not just read about it.
At Stepwik, we built our platform around this idea: learning by doing is the fastest path to mastery.
Why Interactivity Matters
Research consistently shows that active learning outperforms passive consumption. When learners type commands, see real output, and fix errors in a live environment, they build muscle memory and mental models that stick.
Here's what makes a great codelab:
- Clear objectives: each step has one goal
- Progressive complexity: early wins build confidence
- Real environments: no mocking, no sandbox shortcuts
- Instant feedback: errors surface immediately
Creating Your First Codelab on Stepwik
Getting started is straightforward. Head to your Stepwik Studio and click New Lab.
Step 1: Define Your Learning Path
Before writing a single line of markdown, write down:
- Who is this for? (e.g., "junior backend engineers new to Docker")
- What will they be able to do by the end?
- What prerequisite knowledge do they need?
Step 2: Write in Markdown
Stepwik uses Markdown with a few extensions for interactive blocks:
## Install Docker
Run the following command to install Docker on Ubuntu:
```bash
sudo apt-get install docker-ce docker-ce-cli
Note: Make sure you have root or sudo privileges.
### Step 3: Add Verification Steps
Use the `verify` block to let learners confirm they've completed a step:
```markdown
:::verify
Run `docker --version` and confirm the version is 24.x or later.
:::
Step 4: Preview and Publish
Use the built-in preview to walk through the lab as a learner would. Once satisfied, hit Publish and your lab goes live instantly.
Tips from Our Most Successful Authors
- Keep steps short. A step that takes more than 5 minutes should be split.
- Explain the why. Learners who understand why are more likely to finish.
- Include a recap. End every section with a one-sentence summary of what was accomplished.
What's Next
Ready to start? Sign up for Stepwik and launch your first codelab today, or book a demo to see how teams are using Stepwik to onboard engineers faster.