Séria: Ako písať dokumentáciu a manuály v IT projekte
Tester hlási bug:
„API nefunguje podľa dokumentácie.“
Vývojár odpovie:
„To už neplatí. To bolo v starej verzii.“
Tester má otvorený dokument.
Vývojár má v hlave aktuálny stav.
Obaja majú pravdu.
Len každý pracuje s inou verziou reality.…
Séria: Ako písať dokumentáciu a manuály v IT projekte
Support otvorí dokumentáciu.
Nájde riešenie.
Postupuje podľa neho.
Nefunguje.
Po chvíli zisťuje:
A ide sa pýtať kolegu.
Dokumentácia existuje.…
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.…
Séria: Ako písať dokumentáciu a manuály v IT projekte
Vyšla nová verzia systému.
Funkcionalita sa nezmenila zásadne.
Len:
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.“…
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á.…
