Release notes opstellen op basis van commitinformatie
Release notes leggen uit welke wijzigingen belangrijk zijn voor het beoogde publiek. Committeksten geven aanwijzingen, maar het concept moet zichtbaar gebruikersgedrag nog steeds onderscheiden van intern onderhoud.
Begin met het juiste materiaal.
- Wat je aanlevert
- een zichtbare lijst met commits of samengevoegde wijzigingen.
- Het beoogde resultaat
- Sla gegroepeerde release notes op met verwijzingen en expliciete onzekerheden over de impact op gebruikers.
Hoe de workflow werkt.
Groepeer aangeleverde wijzigingen naar hun praktische effect en behoud issue- of commitverwijzingen waar nuttig. Markeer onduidelijke items voor verduidelijking in plaats van te raden wat een afgekort bericht betekent.
Wat je in het resultaat controleert.
Controleer of de wijzigingen daadwerkelijk in de bedoelde release zitten. Een commitbericht alleen toont geen uitrol, beschikbaarheid of volledig effect op gebruikers aan.
Bekijk de Markdown-voorvertoning om naast de tekst ook koppen, lijsten en links te controleren. Bewaar bronverwijzingen bij het document, zodat een beoordelaar belangrijke uitspraken kan herleiden tot je aangeleverde materiaal.
Leer van het uitgewerkte voorbeeld.
Het downloadbare Markdown-voorbeeld laat één mogelijke indeling van het resultaat zien. Lees het naast het bronvoorbeeld en herken vastgelegde feiten, voorgestelde tekst en vragen die nog een antwoord nodig hebben.
Het aangeleverde voorbeeld is ter illustratie. Het is geen vastgelegde uitvoering met jouw gegevens.
Download het voorbeeld ↓Gebruik het met je eigen materiaal.
- Open de bron waarmee je wilt werken en activeer WebAct op dat tabblad.
- Kopieer de taak uit het bovenste blok, voeg vereiste velden of voorkeuren toe en controleer de voorgestelde acties.
- Vergelijk het eerste resultaat met je bron. Vraag waar nodig om een gerichte correctie of verfijning.