Hogyan készítsünk szoftver segédleteket?

Évek óta foglalkozom felhasználói felülettervezéssel. Ha érthetően működik a program, a felhasználó minimális időt fordít a dokumentációk böngészésével. Bármennyire is használható azonban a szoftver, az online segédletek léte ma is alapkövetelménynek számít, ha a felhasználó kiszolgálása a cél.

Cikkemben felvázolok néhány szempontot, melyet érdemes szem előtt tartani akkor, ha technikai dokumentáció elkészítésére adjunk a fejünket.

A felhasználói segédletek célja, hogy elérhetővé tegye azt a tudást, melynek segítségével a felhasználó a lehető leghatékonyabban végre tudja hajtani a kívánt műveletet. Sokan úgy gondolják, hogy súgót írni a legkönnyebb dolog a világon. Készítek néhány screenshootot, és mellékelet egy leírást, mely magyarázza a működést, és meg is vagyok... elég ha grafomán vagyok, nem kell hozzá különösebb képesítés, nem igaz?

Nos, nem. A hatékony felhasználói segédlethez jóval több kell ennél. Az alábbi három kompetenciának kell találkoznia:

  1. A szoftver mögött lévő üzleti terület ismerete. Tudnom kell, hogy milyen mögöttes következménye van egy-egy felhasználói interakciónak, és azt is át kell látnom, hogy mindez hogyan illeszkedik a felhasználó napi munkavégzéséhez.
  2. Technikai dokumentációk írásához szükséges módszertani ismeret. Értenem kell ahhoz, hogy melyek a leghatékonyabb tálalási eszközök. Az, hogy egy adott tudást hogyan lehet megfelelő módon ábrázolni, nos, az didaktikai kérdés. Minél több tapasztalatom van a pedagógiában és az e-learningben, annál eséllyel fogok jó megoldásokat alkalmazni.
  3. Az igényeknek megfelelő HAT(help authoring tool) eszköz alkalmazása. A piacon fellelhető HAT arzenálra jellemző, hogy nagyon sokféle problémára kínálnak megoldást, de nem mindenre. Tapasztalatom szerint ami az egyik cégnél működik, az a másiknál rémálom és fordítva. Érdemes mindenekelőtt felmérni az igényeket, és az alapján eldönteni, hogy mely eszközök együttes használata fogja az optimális megoldást eredményezni.

1. Üzleti tudás

A legnagyobb hiba, amit rendszeresen elkövetnek cégek a felhasználói segédletek megírásakor, hogy fejlesztőkre bízzák azt. Még nem láttam olyan céget, ahol a fejlesztők kihívásként élnék meg ezt a feladatot, és ez így is van rendjén. A jó fejlesztők rendszerint szeretnek tömören fogalmazni, más attitűddel rendelkeznek, mint amivel egy technikai dokumentációírónak rendelkeznie kell.

Amit egy felhasználói segédletnek feltétlenül tartalmaznia kell, az az üzleti tudás, melyet a szoftver támogat. A felhasználónak értenie kell, hogy milyen hatást vált ki egy-egy eseménnyel. Ezt az ismeretet azok a személyek képesek a leginkább megfogalmazni, akik hosszú ideje foglalkoznak az adott témával, akiknek a zsigereiben van az adott üzleti terület. Ezek a személyek az üzleti elemzők.

Mitől leszek hatékonyabb a munkámban, ha ezt a felhasználói felületet használom? Ez a legfontosabb felhasználói kérdés, melyet a súgó oldalak megírása közben feltehetünk magunknak. Ha a felhasználó megtapasztalja, hogy valódi segítség számára a szoftver használata, a dokumentáció elérte a célját. Minden oldalnak, minden bekezdésnek, minden mondatnak ezt a célt kell szolgálnia.

2. Módszertani know-how

Az üzleti elemző ért a szakterülethez, de abban rendszerint nincs gyakorlata, hogy mitől működik egy segédlet. Ezt a hiányosságot tölti be a technical writer szerepkör. Az alábbiakban felsorolok néhány módszertani szempontot, melyet érdemes szem előtt tartani.

1. Célirányos megközelítés. Többnyire egyáltalán nem fontos, hogy a felhasználó értse, hogy miként működik a szoftver. Az a fontos, hogy elvégezze a napi feladatait, és ebben a felület a segítségére legyen. Ha lehetőségünk van rá, a dokumentációk elkészítése előtt végezzünk el egy felhasználók tesztet, melyből képbe kerülhetünk arra vonatkozóan, hogy milyen feladatok elvégzésében segít a program.

2. Jó struktúra.  Világos, áttekinthető struktúrában vezessük végig a felhasználót a folyamatokon. Az egyes képernyők leírása mellett figyeljünk arra is, hogy több képernyőn átívelő madártávlati képet is nyújtsunk az adott használati esettel kapcsolatosan. Rendszerint jól működik az, ha  a képernyőknek megfelelően egy-egy oldal súgót írunk, és ezeket funkcionális tagolásban két-három szintbe tagoljuk. Az egyes fejezetek és alfejezetek lehetnek az áttekintő oldalak, melyekhez nem biztos, hogy tartozik külön felhasználói felület. Ezenfelül érdemes tagolni oldalon belül is a tartalmakat azok jellegének megfelelően (utasítás, fogalommagyarázat, üzleti kontextus, screencast, képernyőképek, stb.).

3. Kimenet. Milyen kimeneti formákra van szükség? A publikációs iránynak számos dimenziója szóba jöhet: publikációs médium (nyomtatott, online help, mobil platform), jogosultságfüggő tartalom (az alkalmazás szerepköreinek megfelelően), támogatott nyelv, stb. Érdemes átgondolni, hogy az egyes szövegek milyen kimenetben fognak megjelenni, és ahhoz igazítani a stílust, formátumot, leírás jellegét.

4. Navigáció és keresés. Figyeljünk arra, hogy a legelején alakítsuk ki a navigációs koncepciót. Különböző bejárási módokat célszerű támogatni attól függően, hogy a felhasználó az adott képernyő helyérzékeny súgójaként, vagy globális segítségkérés gyanánt fordult a súgóhoz. Határozzunk meg világos belépési pontokat, és támogassuk egyaránt a strukturális (tartalomjegyzék, tárgyszavas) és keresés-alapú stratégiákat.

5. Egységes stílus. Kerüljük a körülményeskedő, túlzóan udvarias megfogalmazásokat, melyek zajossá teszik a szövegünket. Fogalmazzunk határozottan, egyszerűen, célratörően, és ugyanazt a stílust vigyük végig a teljes segédleten.

6. Következetesen használt terminológia. Figyeljünk arra, hogy mind az alkalmazásban, mind a segédletben használjuk azokat a fogalmakat, melyet a program célcsoportja használ. Különösen figyeljünk arra, hogy a többnyelvű alkalmazás esetén a fordítónak biztosítsunk hozzáférést a szoftverhez, melyben meggyőződhet a fordítás helyességéről. Nagyon félrevezető tud lenni, ha nem ugyanúgy nevezünk valamit, ahogyan a képernyőn megjelenik. Gyakran előfordul, hogy éppen a technical writer tesz javaslatot bizonyos képernyőn megjelenő szövegek átnevezésére.

3. HAT eszközök

A helyesen megválasztott eszközökön múlik az, hogy költséghatékonyan, gyorsan valósítjuk-e meg azt, amire szükségünk van. Amikor terméket választunk, ne a licencköltséget nézzük, hanem a megoldás szállításának a bekerülési költségét (ROI). Érdemes mindenekelőtt egy kérdőívvel felmérni, hogy az ügyfél mely szempontokat tartja a legfontosabbnak. Tapasztalatom szerint az első megbeszéléskor az a legjobb, ha alaposan kikérdezzük az ügyfelet. Ekkor még nem érdemes terméket említeni: a megrendelőnek látnia kell, hogy az eszköz csak egy a három kritériumból, mely a sikerességet biztosíthatja.

Következzen néhány szempont, melyet minden esetben érdemes végiggondolni, ha eszközválasztásban törjük a fejünket:

  1. Elvárt végeredmény. Milyen formátumokban kell disztributálni a segédletet? Szükség van szerepkör támogatásra?
  2. Munkamódszer. Milyen szintű tartalommenedzsment funkcionalitásra van szükség? Várhatóan hány szakértő fog dolgozni a segédleteken? Szükség van jóváhagyóra?
  3. Beépített tartalomszerkesztő, vagy külső tartalomszerkesztő? Milyen formátumokat kell támogatni? Milyen konverziós eljárásokra kell felkészülni?
  4. A single source publishinget milyen szinten kell megvalósítani? Tartalomszintű SSP-re is szükség van, vagy elég a médium szintű megközelítés? Milyen hangsúlyt kapnak a nyomtatható anyagok?
  5. Milyen nyelveket kívánnak támogatni? Fontos-e a fordítások import/exportja?
  6. Build támogatás. Szükség van-e arra, hogy automatizáltan, kívülről paraméterezve lehessen meghívni a HAT-ot publikáció céljából?

Új hozzászólás

Hozzászólások

Tudnál esetleg pár könyvet ajánlani referenciának hasonló témában? Érdekelne a dolog.

Könyvet nem tudok ajánlani. Cikkeket igen. Pl: http://www.cherryleaf.com/articles

A ROI mellett fontos mutató a TCO (Total Cost of Ownership) is! 

Szia Blogger!
Gonosz leszek, ne haragudj!
Már rég levettelek RSS-ről, egyre ritkábban írsz egyre értelmetlenebb dolgokat. Lehet, valami életvezetési probléma vagy a szennyezett drogok hatása.
Ez a cikk ajánlásként jutott el hozzám, de eléggé felpaprikázódtam tőle. Ami persze végül is közel áll a kiváltani kívánt hatáshoz, mert a hatás a lényeg az írásnál és az olvasottság. Ebből következően Te egy nyertes, sikeres ember vagy. Ha elgondolkodom rajta, végigolvasom, már megérte, eredményes kísérlet volt. De nem olvasom végig, mert egy bekattant marhaság. Vastagon tele bullshit-ekkel, túlbonyolítással, parasztvakítással. Ez az írás nem a publikus internetre való. Az ilyen szösszeneteket az ostoba/böszme vezérigazgatócskáknak kell eldugni az árajánlatba.
„a lehető leghatékonyabban végre tudja hajtani” – tényleg, nem mondod, hogy ez egy igény?!
A jó user interface műves ritka, mint a női hídmester, az tény, de nem azért mert csak a kiválasztott kevesek képesek felfogni, hogy hová kell tenni egy gombot, ahhoz, hogy a felhasználó előbb találjon rá, mint, hogy telefonáljon. Ha valaki nagyon unatkozik, a kubikolásról is lehet ennyit írni, ennyire túlbonyolítani és oly módon beállítani, mintha ez valami egészen különleges dolog lenne.
Egyébként meg, ha valaki kezelni akar valamit, mert motivált vagy motiválják, akkor megtanulja. Nagyon jó, hogy olyan világot élünk, ahol az olyan tök lényegtelen dolgokra egzisztenciát lehet építeni, mint ez.
Minap valaki egy társaságban arról beszélt, hogy nem tudja eldönteni, hogy az új beltéri ajtóikban milyen szigetelőanyag legyen. Legszívesebben torkon rúgtam volna, de már kinőttem belőle. Ezek olyan "problémák", amik nem azok. Unatkozó emberek kísérletei a lét imitálására. Nevezhetjük sznobságnak is, de az előző mondat jobban sikerült. Technokrataságnak semmiképpen sem nevezném, mert számomra az egy pozitív és szakmai fogalom.
Üdv:
Olvasó

húh, ha gonosz nem is, de gorombának goromba volt...

Lehámozva a stilisztikát, próbálom értelmezni, hogy mire is szóltál most be. Melyik része a bullshit? Mesélj!

egyre ritkábban írsz egyre értelmetlenebb dolgokat.

Igen, valóban egyre ritkábban írok. Ez egy ilyen időszak.Ezekszerint úgy gondolod, hogy volt idő, amikor nem értelmetlen dolgokról írtam? Melyik írásaimtól telt be a pohár?

egyre ritkábban írsz egyre értelmetlenebb dolgokat.egyre ritkábban írsz egyre értelmetlenebb dolgokat.egyre ritkábban írsz egyre értelmetlenebb dolgokat.egyre ritkábban írsz egyre értelmetlenebb dolgokat.

Hát nem volt egy elegáns és szeretre méltó figura ez az Anonymus.... De kár is érte ....  !!! 

  És ilyen rossz sítulssal meg olyan nagyon kár véleményezni , roncsolós és beteges , önszeretetlen ....

I would like to show my respect for your kindness supporting persons that really need guidance on this important matter. Your real dedication to getting the solution all through had become rather useful and has truly enabled people much like me to reach their goals. Your own helpful information signifies a great deal to me and even more to my office workers. Best wishes; from each one of us.

I wanted to write a small word so as to say thanks to you for these fantastic tips and hints you are sharing on this website. My time intensive internet research has at the end been honored with incredibly good information to write about with my contacts. I would express that we visitors are really endowed to be in a really good place with many wonderful individuals with good techniques. I feel truly lucky to have seen your webpage and look forward to many more entertaining minutes reading here. Thank you once again for all the details.

I'm also commenting to make you be aware of of the fine experience my cousin's child gained browsing the blog. She noticed several pieces, with the inclusion of how it is like to possess a wonderful helping nature to have the mediocre ones very easily know just exactly chosen impossible matters. You actually surpassed readers' expectations. I appreciate you for coming up with the priceless, safe, educational not to mention cool thoughts on that topic to Mary.

Thank you so much for providing individuals with an exceptionally nice possiblity to check tips from this blog. It is often so useful and as well , full of a great time for me and my office peers to visit the blog a minimum of thrice in a week to find out the new issues you have. Not to mention, I'm just usually happy with all the incredible tips and hints you give. Selected 2 ideas in this post are ultimately the simplest I have ever had.

I actually wanted to type a simple note in order to thank you for some of the great advice you are placing on this website. My extended internet lookup has at the end been compensated with incredibly good content to share with my pals. I 'd mention that most of us website visitors actually are very endowed to be in a perfect website with many brilliant professionals with very beneficial tips and hints. I feel rather grateful to have used your web pages and look forward to tons of more fabulous times reading here. Thanks once more for a lot of things.