Terug naar Kennisbank Overzicht Stijlgids & Standaarden v1.0
Documentatie Standaard voor BykPoint

Schrijf- en Stijlrichtlijnen voor Handleidingen

Om te garanderen dat elke fietsenmaker, monteur of baliemedewerker direct zelfstandig uit de voeten kan met onze software, volgen alle handleidingen en taakinstructies onderstaande 5 gouden regels en het officiële sjabloon.

1

Begin altijd met Actiewerkwoorden

Schrijf taakgericht en gebiedend. Vermijd passieve constructies zoals „Er kan worden geklikt op...”. Gebruik altijd actieve werkwoorden:

  • • Navigeer naar...
  • • Klik op...
  • • Voer in / Typ...
  • • Selecteer...
  • • Bevestig met...
2

UI-Elementen Consequent Vetgedrukt

Elke knop, invoerveld, menutab, checkbox of keuzelijst die de gebruiker op het scherm ziet, wordt altijd vetgedrukt geschreven met de exacte spelling van het scherm.

❌ Fout: Klik op nieuwe order en vul de datum in.
✅ Goed: Klik op + Nieuwe Werkorder en selecteer de gewenste datum in het veld Ophaaldatum.
3

Geen Technisch Jargon (Spreek Fietstaal)

De lezer is een fietsenmaker of winkelbediende, geen databasebeheerder. Vervang programmeertermen door herkenbare werkplaatsbegrippen:

Vermijd (Technisch)Gebruik (Praktijk)
Tenant / InstanceJouw Rijwielzaak / Vestiging
Booking entity / recordWerkorder / Werkbon
SKU / Item codeArtikelnummer of Barcode
POS transaction payloadKassa-afrekening / Kassabon
Wholesaler API callBestelling bij Grossier (Kruitbosch/Shimano)
4

Sluit Altijd af met Verwacht Resultaat

Een monteur wil bevestiging dat zijn handeling geslaagd is. Benoem aan het eind van elk stappenplan exact wat er nu zichtbaar of verstuurd is:

✅ Resultaat:

De status verandert naar 'Wacht op onderdelen', de werkbon rolt uit de printer en de klant ontvangt een WhatsApp-notificatie.

Het Officiële Handleidingsjabloon

Kopieer onderstaande indeling voor elke nieuwe handleiding of uitbreiding.

### Taak: [Actieve Werkwoordstitel, bijv. "Een binnengebrachte fiets innemen"]

**Doel:** [1 heldere zin die het eindresultaat voor de monteur of klant beschrijft]

**Wat heb je vooraf nodig?**
- [Vereiste 1: bijv. Klantgegevens of merk van de fiets]
- [Vereiste 2: bijv. Beschikbare werkplaatsplek of barcode scanner]

**Stappenplan:**
1. **Navigeer** naar het tabblad **[Tabbladnaam]** in het linkermenu.
2. **Klik** op de knop **[Knopnaam]** (of gebruik sneltoets `[Toets]`).
3. **Typ** [waarde] in het veld **[Veldnaam]**.
4. **Selecteer** [optie] uit het uitklapmenu **[Menunaam]**.
5. **Bevestig** de handeling met de knop **[Bevestigingsknop]**.

💡 **Slimme Tip:** [Praktische tip die tijd bespaart in de werkplaats]

⚠️ **Let op:** [Belangrijk aandachtspunt om vergissingen of dubbel werk te voorkomen]

✅ **Resultaat:** [Wat ziet de gebruiker nu op het scherm of wat is er afgedrukt/verstuurd?]

Voorbeeld zoals het in de handleiding verschijnt:

Voorbeeld Taak 1.1

Een fiets aannemen en werkbon printen

Doel: De klant aan de balie snel helpen en direct een genummerde werkbon uitprinten voor aan het stuur.

Wat heb je nodig?
  • Mobiel telefoonnummer van de klant
  • Merk en fietstype (bijv. Gazelle E-bike)
Stappenplan:
  1. Navigeer in het menu naar Werkplaats en orders.
  2. Klik op de groene knop + Nieuwe Werkorder.
  3. Typ het telefoonnummer in het veld Telefoonnummer; bestaande klanten worden automatisch geladen.
  4. Kies bij Fietstype de categorie (bijv. E-bike of Stadsfiets).
  5. Vink eventueel Leenfiets meegeven aan en kies het nummer van de leenfiets.
  6. Klik op Opslaan & Printen.
Slimme Tip:

Heeft de klant haast? Typ alleen de achternaam en het telefoonnummer in; de rest kan de monteur later bijwerken.

Resultaat:

De werkbon wordt afgedrukt met barcode, en de fiets verschijnt direct bovenaan in de kolom In afwachting.