Wijzigingen in technische documentatie nauwkeurig samenvatten
Een overzicht van documentatiewijzigingen helpt lezers bijgewerkte instructies, interfaces of aannames te vinden. Het is nuttig als de relevante versies of wijzigingsrecords samen worden aangeleverd.
Begin met het juiste materiaal.
- Wat je aanlevert
- twee documentatieversies die samen worden aangeleverd of een uitgevouwen tekstverschil.
- Het beoogde resultaat
- Sla gewijzigde instructies, verwijderde stappen en migratievragen op zonder opdrachten uit te voeren.
Hoe de workflow werkt.
Vergelijk overeenkomstige onderdelen en leg betekenisvolle toevoegingen, verwijderingen en revisies uit. Behoud exacte namen en versieverwijzingen wanneer een kleine tekstwijziging invloed heeft op gedrag of compatibiliteit.
Wat je in het resultaat controleert.
Controleer de samenvatting aan de hand van beide versies. Een gewijzigde zin bewijst niet dat de software zelf is veranderd, en ontbrekend materiaal in één fragment kan wijzen op onvolledige dekking in plaats van bewuste verwijdering.
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.