Release notesTechnische documentatie

Release notes en changelog voor updates van je product

Meestal klaar in 15 minutenRevisies inbegrepenKwaliteitscontrole
Pakketten
BetaalbeschermingDetails
  • Revisies binnen het pakket zijn gratis.
  • Reageer je niet binnen 3 dagen na levering, dan wordt het werk automatisch goedgekeurd.

Het geld wordt bij betaling gereserveerd en pas vrijgegeven als je het werk goedkeurt.

Release notes en changelog voor updates van je product

Voorbeeldresultaat

Voorbeeld voor het pakket Standaard

SOP set: opening and closing procedures for a small café

SOP-02: Closing the café

PurposeLeave the café clean, safe and ready for the morning shift
WhoThe closing barista; the shift lead signs off
WhenStart at 5:30 pm, doors locked at 6:00 pm, finished by 6:45 pm
You needClosing checklist sheet, till key, cleaning caddy, blue cloths

Before you start

Warning: Never switch off the main power at the wall. The fridges and the alarm run on the same board.

Steps

  1. At 5:30 pm, turn the door sign to "Last orders". Customers already inside can stay until 6:00.
  2. Switch the coffee machine to rinse mode. Press and hold the cup button for 5 seconds. You should see: "RINSE" flashing on the display and hot water running through both group heads for about 2 minutes.
  3. Take out the portafilters and soak them in the black container with one cleaning tablet. Leave them for 20 minutes.
  4. Move cakes and sandwiches to the back fridge. Label anything opened today with today's date and "Use by tomorrow".
  5. Record the fridge temperatures on the log sheet. You should see: between 1 °C and 5 °C. If a fridge shows above 5 °C, go to step 12 first.
  6. At 6:00 pm, lock the front door and turn the sign to "Closed".
  7. Close the till. Press MENU, then "End of day", then "Z report". You should see: the report printing with today's total. Do not count the cash at the counter; take the drawer to the office.

(Steps 8–14: floors, bins, alarm and handover note.)

If something goes wrong

ProblemWhat to do
Fridge above 5 °CMove food to the second fridge, note the time and temperature, message the shift lead
Z report does not printReplace the paper roll; if it still fails, write the total from the screen and photograph it
Alarm will not setCheck the back door is fully shut; the alarm will not arm with it open

Sign-off

Closing barista: name, time. Shift lead: initials.

Last reviewed: [date]. Review again when the coffee machine or till is replaced.

Client: Bluebell Café, 22 seats, 7 staff working in rotating shifts Input: the owner's voice notes, a handwritten checklist and 9 photos of the counter, coffee machine and till screen Delivered: a set of 6 SOPs (4,600 words): opening, closing, cash handling, fridge temperature log, deep-cleaning the coffee machine, handling a customer complaint. Below: an excerpt of the closing procedure.

De klant en alle details zijn verzonnen.

Over deze dienst

Gebruikers negeren release notes die klinken als commitberichten en missen de wijziging die hen echt raakt. Wij maken van je tickets, commitlijst of interne aantekeningen release notes die mensen lezen: wat er nieuw is en waarom dat ertoe doet, wat er in de werkwijze is veranderd, wat is opgelost en welke actie gebruikers moeten ondernemen. Je krijgt ook een changelog-item met datum in een vast formaat en korte versies voor een banner in de app of voor e-mail.

Wat is inbegrepen

  • Wat je krijgtRelease notes, een changelog-item en korte versies voor in de app en per e-mail als Markdown-tekst, klaar voor je changelogpagina, App Store-notities of nieuwsbrief. Je krijgt ze ook als Word-bestand (.docx) of PDF.
  • Eerst het voordeel voor de gebruikerWat de wijziging voor hen betekent
  • Gegroepeerde wijzigingenNieuw, verbeterd, opgelost
  • Actie vereistIngrijpende wijzigingen uitgelicht
  • Korte versiesVoor appstores, banners en e-mail

Hoe het werkt

  1. 1
    BriefingJe plakt de lijst met wijzigingen
  2. 2
    Opzet en schrijvenWij sorteren en herschrijven ze
  3. 3
    LeveringJe ontvangt release notes en changelog

Wat we van je nodig hebben

Je lijst met wijzigingen (tickets, commits of aantekeningen), het versienummer en de datum, wie je gebruikers zijn en screenshots van nieuwe functies als je die hebt.

We vragen je:

  • Wat voor product is het?
  • Plak de lijst met wijzigingen voor deze release
  • Waar worden de notes gepubliceerd?

Pakketten vergelijken

PakkettenBasis1 release€ 9StandaardTot 4 releases€ 18PremiumTot 12 releases€ 35
Levertijd1 dag3 dagen5 dagen
Revisies123
Lengtetot 800 woordentot 2.500 woordentot 6.000 woorden
Releases1tot 4tot 12
Korte versiesJaJaJa
Bestellen BasisBestellen StandaardBestellen Premium

Betaalbescherming

Je betaalt bij het bestellen, maar het geld wordt alleen vrijgegeven voor goedgekeurd werk.

  • Vaste prijsDe prijs van het pakket verandert niet meer nadat je hebt betaald.
  • Het geld wordt gereserveerdBij betaling wordt het bedrag alleen gereserveerd. Het gaat pas naar de dienst als je het werk goedkeurt.
  • Gecontroleerd vóór leveringElk resultaat doorloopt een kwaliteitscontrole voordat het bij jou komt, en je ziet het op de bestelpagina voordat je het goedkeurt.
  • Gratis revisiesVraag wijzigingen binnen je briefing aan, zo vaak als het pakket toestaat.
  • Goedkeuring na 3 dagenKeur je het werk binnen 3 dagen na levering niet goed en vraag je ook geen wijzigingen, dan wordt het automatisch goedgekeurd. Schrijf je na levering in de chat van de bestelling, dan wacht de bestelling; zodra we hebben geantwoord, kunnen we de 3 dagen opnieuw laten ingaan en melden we dat in de chat.
  • Opnieuw doen of volledige terugbetalingPast het resultaat niet bij je briefing en hebben de revisies dat niet opgelost, of duurt het werk meer dan twee keer zo lang als de levertijd, schrijf dan in de chat van de bestelling: we doen het werk opnieuw of betalen het volledige bedrag terug.
Hoe het werkt →

Vragen en antwoorden

Kunnen jullie de "Wat is er nieuw"-tekst voor de App Store schrijven?

Ja, bij elke release zit een korte versie die in het veld van de store past.

Worden interne ticketnamen verborgen?

Ja. Wij herschrijven ze in de taal van de gebruiker en laten interne fixes weg die gebruikers nooit merken, tenzij je vraagt ze te houden.

Kunnen jullie meerdere eerdere releases beschrijven?

Ja, Standaard en Premium dekken meerdere versies, handig als je een openbare changelog begint.

Staat je antwoord er niet bij?

Pakketten