Tanulás és szövegellenőrzés
Verziójegyzet: mit változtat a frissítés a használaton?
A verziójegyzet a felhasználó számára érzékelhető változást mondja el. A „kisebb javítások” helyett nevezd meg, mi működik másként, milyen helyzetben jelentkezett a hiba, és kell-e valamit tennie az olvasónak.
A cikk tartalma
A korábbi helyzetet és az eredményt kösd össze
A hibajavítás akkor érthető, ha megnevezed a kiváltó helyzetet. Például egy hosszú fájlnév korábban levágta a letöltés gombját, a frissítés után több sorba törik. Az állítás csak ellenőrzött működésre vonatkozzon.
Ne általánosíts egy részjavításból
Az „összes mobilhiba javítva” túl erős, ha csak egy nézetet ellenőriztél. Nevezd meg a konkrét felületet. A fejlesztői feladat neve helyett a használati következményt írd le; a belső fájlnevek többnyire nem segítik a látogatót.
Saját szerkesztési példa
- Homályos: Optimalizálások és hibajavítások.
- Pontosabb: A hosszú dokumentumnevek most több sorban jelennek meg, ezért a letöltés gombja keskeny képernyőn is elérhető marad.
Az alábbi helyzet és adatok szemléltető példák.
A szükséges lépést emeld ki
Ha frissítés, új beállítás vagy adatátvitel szükséges, az külön mondatot kapjon. Ha nincs felhasználói teendő, azt csak akkor állítsd, ha ellenőrizted. A verziószám és a dátum segít később visszakeresni, melyik változásról szólt a közlés.