neco Logo

How to Write a New Tutorial?

First Steps

  1. Copy the _example-tutorial folder
  2. Rename it e.g. new-neco-feature-or-so – no spaces/umlauts (becomes the tutorial's URL)
  3. Open tutorial.md and fill in 'title'
  4. Write your tutorial with clear steps
  5. Additional images (screenshots etc.) go in the /images subfolder. Embed with ![Alt-Text](./images/screenshot.jpg). See screenshot example below

Screenshots and Images in Tutorial

Sometimes a picture is worth a thousand words. Here's an embedded image:

Image showing a large tree on a green meadow

Tips for Good Tutorial Screenshots

  1. High Resolution: At least 1080p so details are visible
  2. Mark Important Areas: Red circles, arrows or highlights
  3. Clean UI: No personal data, hide notifications
  4. Consistent Size: Similar crop areas for uniform appearance

Practical Tips

Avoid Common Mistakes

  • Steps Too Long: Better more, smaller steps than few large ones
  • Outdated Screenshots: Regularly check if the UI is still current

Optimize Images

The system optimizes images automatically, but you can help:

  • Size: Upload original resolution, system automatically creates different sizes
  • File Size: Don't compress too much, quality is more important

Example Structure:

---
title: 'Use New Feature'
---

Brief description of what the tutorial accomplishes and why it's useful.

## Step 1: Preparation

Description of the first step...

![Screenshot of the first step](./images/step1.png)

## Step 2: Main Action

Description of the second step...

![Screenshot of the second step](./images/step2.png)

## Step 3: Completion

Description of the final step...

![Screenshot of the result](./images/result.png)

### Additional Notes

- Tip 1
- Tip 2
- Troubleshooting if needed