szoftverfejlesztés  –  szoftver súgó készítés  –  kiadványszerkesztés  –  szöveggondozás  –  szakillusztrációk  –  nyomdai előkészítés  –  képfeldolgozás  –  szövegfeldolgozás  –  összetett feladatok
Taracsák Gábor honlapja
  Kezdőlap | Bemutatkozás | Munkafilozófiám | Szoftverfejlesztés | Súgó készítés | Kiadványszerkesztés | Referenciák | Csillagászat |

Információk


Súgó és dokumentáció
  formátumok


Referenciák


Szoftver súgók és
  dokumentációk

Különleges feladatok



Levél küldése
Vissza a lap elejére
Vissza a lap elejére
 
Vissza a lap elejére
 

SZOFTVER SÚGÓ KÉSZÍTÉSE

Tévedni emberi dolog,
de ha igazán el akarsz rontani valamit,
akkor számítógépre van szükséged.
Paul Ehrlich

Szoftver súgó, dokumentáció készítése

 

Gyakran találkozhatunk olyan számítógépi programokkal – olykor még a neves szoftvergyártók termékei között is – amelyek csak formális, felületes dokumentációt tartalmaznak, és működésük számos részletét csak a gyakor­latban, időt rabló próbálkozások sorával lehet megismerni. Az egyedi megren­delésre fejlesztett szoftverek esetében pedig még rosszabb a helyzet. A  szoftverfejlesztők többsége nem szeret dokumentációt írni, ami fájdalmasan megmutatkozik a gyenge tartalmú, igénytelen kivitelű súgókban, sőt olykor a súgó teljes hiányában.

A felhasználó számára érthető, áttekinthető és hatékonyan használható súgó készítéséhez persze nem is elegendő csupán a számítógépes világot és a  dokumentálandó szoftvert ismerni. Szükséges hozzá jó pedagógiai érzék, oktatási, ismeretterjesztési tapasztalat is. Sok éve foglalkozom szoftver­fejlesztéssel és még több ideje ismeretterjesztéssel, oktatással, így mindkét területen kellő gyakorlattal rendelkezem. Nem csak a megrendelésre fejlesztett szoftvereimhez, hanem még a „belső használatra” vagyis saját egyéb számítógépes munkáim segítésére készített programokhoz is mindig írok súgót. Emellett több gyári szoftverhez is összeállítottam magyar nyelvű használati útmutatót vagy oktatási segédanyagot. A referenciák között bemutatok több különböző formátumú és jellegű példát.

Mindezek alapján sok éves tapasztalattal vállalom szoftver súgók, leírások, használati útmutatók, vagy egyéb hasonló célú hiperszöveg dokumentumok készítését magyar, angol és német nyelven.

A forrásanyag akár nyers, formázatlan, szerkesztetlen szöveg is lehet. Magyar nyelvű súgó vagy dokumentáció esetében – ha kívánja – elvégzem az olvasószerkesztést is. Ez a helyesírás, a nyelvhelyesség, a stílus és az érthetőség ellenőrzését jelenti. Sőt, ha forrásszöveg helyett csak vázlatos elképzelései vannak, akkor a szoftver alapján esetleg még a súgó szövegét is megírom. A súgók bármelyik elterjedtebb formátumban készülhetnek, a nyomtatható útmutatók pedig PDF-ben vagy valamely ma használatos szöveg­szerkesztő formátumában.

Miért kell a jó súgó?

Manapság egy átlagos otthoni számító­géphasználó is számos különféle szoftvert kénytelen igénybe venni.
Akit a munkája köt a számítógéphez, annak pedig akár több tucat programot is ismernie kellene. Ezeknek a szoftve­reknek a többsége egyre szerteágazóbb szolgáltatáskészletet és általában bonyolult kezelőfelületeket tartalmaz.

A nem napi rendszerességgel használt programok esetében még az alapvető funkciók működtetésének módját sem könnyű fejben tartani. A számtalan almenüpont, eszköz, nyomógomb és egyéb kezelőelem többségére pedig csak igen ritkán van – vagy esetleg egyáltalán nincs is – szükség. Mindezek megtanulása egyfelől szinte lehetetlen másfelől viszont felesleges is volna. Ezért elengedhetetlen tartozéka minden szoftvernek a logikusan összeállított és könnyen kezelhető súgó.

Persze nem csak szoftverekhez, hanem nagyobb munkahelyi, intézményi háló­zatokhoz is nélkülözhetetlen lehet a részletes használati útmutató, amelyből megismerhető a hálózat szerkezete, a dolgozók munkájához szükséges belső adatbázisok, információtárak, prog­ramok helye és kezelésük módja.

  © fotók: Büttner György, Fehér Sándor, Tóth Lajos Impresszum © 2010–2020 Taracsák Gábor
Levél küldése. Kérem, kézzel írja be a címet! Taracsák Gábor honlapja