verzie

Dokumentácia a používateľské príručky, Manuály pre technickú podporu

Ako udržiavať support dokumentáciu aktuálnu (verzie, zastarané riešenia, archivácia)

Séria: Ako písať dokumentáciu a manuály v IT projekte

 

Reálny problém z praxe

Support otvorí dokumentáciu.

Nájde riešenie.

Postupuje podľa neho.

Nefunguje.

Po chvíli zisťuje:

  • postup je zastaraný
  • systém sa medzitým zmenil
  • workaround už neplatí

A ide sa pýtať kolegu.

 

Čo sa tu vlastne pokazilo (analýza systému)

Dokumentácia existuje.…

Ako testovať..., CMS (Content Management System), Konkrétne oblasti

Ako testovať verzovanie obsahu (história zmien, rollback)

Príklad

Predstav si redakčný systém, v ktorom editor upraví už publikovaný článok. Pri úprave omylom prepíše dôležitý odsek, zmení titulok a odstráni interný odkaz. Na prvý pohľad je všetko uložené správne, ale po zverejnení si tím všimne, že článok má horší význam, chýbajú v ňom dôležité informácie a prepadla sa aj návštevnosť z vyhľadávania.…

Dokumentácia a používateľské príručky, Používateľské manuály

Ako písať používateľský manuál tak, aby odolal novým verziám

Séria: Ako písať dokumentáciu a manuály v IT projekte

Reálny problém z praxe

Vyšla nová verzia systému.

Funkcionalita sa nezmenila zásadne.
Len:

  • pribudlo tlačidlo
  • zmenil sa názov jedného poľa
  • presunul sa krok do inej časti obrazovky

Manuál bol zrazu nepoužiteľný.

Používateľ postupoval podľa neho a zasekol sa na kroku:
„Kliknite na tlačidlo Export vpravo hore.“…

Ako testovať..., Používateľská skúsenosť a UI, Všeobecné témy

Ako testovať vizuálne rozdiely medzi verziami (regresné UI testy)

Príklad:
Predstav si e-shop, ktorý spustil novú verziu katalógu produktov. Dizajnér zmenil farby tlačidiel, upravil font nadpisov a pridal viac miesta medzi jednotlivé položky filtrov. Tester má preveriť, či sa tieto zmeny prejavili presne podľa návrhu a či sa nezmenilo nič, čo sa meniť nemalo – napríklad rozbité zarovnanie textu, posunuté obrázky alebo neviditeľné tlačidlá.…

Návrat hore