09 óra

Felhasználói dokumentáció

A felhasználói dokumentáció olyan leírás, amely a szoftver végfelhasználóinak szól. Ez a dokumentum bemutatja, hogyan kell a szoftvert használni, és segít a felhasználóknak megérteni annak működését. A felhasználói dokumentáció részletes, gyakran „szájbarágós”, és a nulláról indul, így még azoknak is segít, akik kevés tapasztalattal rendelkeznek a szoftverekkel kapcsolatban.

A felhasználói dokumentációnak tartalmaznia kell az alábbiakat:

• A program használatának bemutatását, lehetőleg kpernyőképekkel illusztrálva.
• Egy példafutást, részletesen bemutatva.
• A lehetséges hibahelyzeteket és azok kezelésének módját.
• Kapcsolattatást a program fejlesztőivel, help deskkel, vagy a forgalmazóval.

Az útmutató összeállításakor figyeljünk arra, hogy egyértelműen és világosan fogalmazzunk, az illusztrációk is legyenek olvashatók, értelmezhetők. A dokumentáció készítésekor használjuk az üzleti nyelvet és kerüljük a technikai zsargont.

A felhasználó ismeretei eltérhetnek, ezért az útmutatót úgy kell összeállítani, hogy a felhasználók felkészültségüktől függetlenül egyszerűen megtalálják a rájuk vonatkozó információkat.

A dokumentációt várhatóan egyetlen felhasználó sem olvassa el az elejétől a végéig, ezért törekedni kell könnyű kezelhetőségre, valamint a háttérinformációk közlését is csak a legszükségesebbekre kell korlátozni.

Wiki oldalak

A Wiki oldalak a felhasználói dokumentációk számára is kiváló lehetőséget biztosítanak, mivel lehetővé teszik, hogy az érintett felhasználók gyorsan megtalálják az általuk keresett részeket. A hyperlinkek segítségével az egymáshoz kapcsolódó témaköröket is könnyen el lehet érni.

A túl sok hiperlink használata összezavarja a felhasználót

Vigyázzunk arra, hogy a kapcsolatok között csak a szükségeseket jelöljük hiperlinkekkel a felhasználói dokumentációban, ugyanis azokon lépegetve könnyen elveszhet az olvasó az információk tengerében. Kerüljük a túlzott linkhasználatot!

Gyakori probléma az említetteken túl az is, hogy a felhasználói dokumentációban alkalmazott rövidítéseket nem minden esetben magyarázzák meg. Főszabály az, hogy ha már alkalmazunk egy rövidítést, akkor azt az első használatát megelőzően specifikálni kell. Egy wiki oldalon az előfordulásoknál a magyarázatot tartalmazó szövegre hiperlinket kell helyezni, de legjobb az, ha a magyarázat tooltipként jelenik meg és nem navigál el az aktuális oldalról.

Felhasználóbarát felhasználói dokumentáció

A technikai dokumentációk egyik legnagyobb hátránya, hogy rendkívül szárazak, többnyire még a szakemberek számára sem jelentenek könnyed olvasmányt. Leszámítva a referencia dokumentumokat, amit szótárszerűen használunk, a dokumentáció is olyan kommunikációs forma, ahol érvényesek az emberi figyelem korlátai. Ha hosszabb ideig szeretnénk fenntartani az olvasó figyelmét, vagy fontos információt szeretnénk közölni, ott használjunk olyan elemeket, amelyek megragadják és fenntartják a figyelmet. Ez a box is, amelyet éppen olvasol, valami hasonló célt szolgál - megtöri a folytonos szöveget és megpróbálja egy kicsit feldobni az oldal monotonitását. Használjunk bátran, de természetesen célhoz kötötten grafikai elemeket a dokumentációnkban, amelyek ugyanezt a célt szolgálják.

Az emberek többsége vizuális típus. Ez azt jelenti, hogy az átadott információt képi formában dolgozza fel. Meglepő lehet, de képi formában nagyon sok információ közölhető, még absztrakt fogalmak is. Ennek eszköze lehet az infógrafika.

Infografikák

Az infógrafika olyan vizuális szemléltető eszköz, amely információkat grafikus formában közvetít. A szó két részből áll: információ és grafika. Az infógrafika célja, hogy a felhasználó gyorsan megértse az átadott üzenetet, és ezért kevés szöveget tartalmaz, inkább grafikus adatokkal dolgozik. Gyakran találkozhatunk vele adatok megjelenítésekor, fogalmak magyarázásánál, marketing eszközként és az oktatásban is.

Kinek készítjük a dokumentumot?

A válasz akár egyszerűen is megfogalmazható, a felhasználónak. Egy szoftver esetében azonban több felhasználóról beszélhetünk, akik a használat során különböző szerepköröket töltenek be. A felhasználói dokumentáció készítése során annak szerkezetének meghatározásában figyelembe kell venni az eltérő felhasználói szerepköröket. Célszerű úgy szerkeszteni a dokumentumot, hogy az egyes felhasználókra, illetőleg szerepkörökre vonatkozó leírások eltérő szekciókban jelenjenek meg. Ez a felépítés segíti a felhasználókatt, hogy a rájuk érvényes szakaszokat könnyebben megtalálják és jobban fókuszáljanak azokra az információkra, amelyek rájuk vonatkoznak.

A felhasználók és szerepkörök azonosítása legkönnyebben egy jól megírt user story alapján történhet, azonban nem minden fejlesztési modellben használnak user storykat. Ilyen esetekben a feladat leírása, valamint a kapcsolódó use case diagramok segíthetnek.

Create saveable configuration for GUI

"Current behavior: user must set all fields each time. Expected behavior: users can save the actual settings to a local file if they want. If the current name is used, a confirmation window is shown. Users can decide to rewrite or rename the current settings. The user can open previously saved configurations.The format should be JSON."

A feladathoz az alábbi use case ábra tartozik.

Akár az ábrát, akár a szövegezést tekintjük, egyszerűen csak felhasználóként hivatkozunk ennek a funkcionalitásnak érintettjeire. Valóban, ha belegondolunk minden olyan felhasználó számára, aki futtatja a programot, ez a feature hasznos funkcionalitást jelent. A programot leginkább azok a felhasználók futtatják, akik a bemutatókat tartják és szeretnék, ha a különböző célcsoportok és szoftverek esetében ne kelljen egyenként beállítani a megfelelő paramétereket, csak bemutatni az eredményeket. Ez a kör jellemzően a vezető fejlesztő, projektmenedzser, de haszonélvezői mindazok a személyek, akik számára a prezentáció készül, azaz az ügyfelek, menedzsment, product owner.

Összefoglaló

A fejlesztői és felhasználói dokumentáció mellett még egy dokumentum típusról kell beszélni, ez pedig a projekt összefoglalója. Az összefoglaló az érintettek harmadik csoportjának, azaz a projektvezetésnek, illetőleg a menedzsmentnek készül. Ebből adódóan ebben a dokumentumban azokat a szempontokat kell kiemelni, amelyek a menedzsment számára fontosak. Nem szabad ezt a dokumentumot technikai részletekkel, vagy a szoftver jellemzőivel telezsúfolni, hanem elsősorban a projekt haladásra, a tervek teljesítésére, az eltérésekre és azok okaira kell koncentrálni.

Melyek az összefoglaló főbb jellemzői?

• Menedzsereknek készül
• A projekt alakulásáról tartalmaz információkat
  • Projekt azonosítói
  • A projekt célja
  • Projekt vezetője, projekttagok
  • Az ügyfélkör
  • Tevezett ütemezés és erőforrások
  • A tervek teljesítése, eltérés a tervektől és azok indoklása
  • Költségtényezők
• Sikeresség megítélése

Fontos, hogy az összefoglaló legyen rövid, tömör, kimutatásokat, táblázatokat és diagramokat jellemzően tartalmazhat. Az összefoglaló dokumentum esetén üzleti nyelvet kell használni, kerülni kell a szakmai zsargonokat, rövidítéseket.