Technická dokumentácia Viac ako návod na použitie ›Časopis Webwriting - od publikovania
Zavádzanie nového produktu je spojené s mnohými krokmi. Produkt musí byť starostlivo naplánovaný a každý vývojový krok je starostlivo preskúmaný. Keď je produkt dokončený a pripravený na uvedenie na trh, vývojár by sa mal ubezpečiť, že starostlivo vyplní technickú dokumentáciu k produktu. Zákonodarcovia požadujú podrobnú technickú dokumentáciu na zaistenie bezpečnosti a správneho fungovania produktu. Vďaka technickej dokumentácii pomôžete nielen používateľovi produktu, ale aj svoju spoločnosť ochránite pred možnými právnymi útokmi. To znižuje riziko zodpovednosti a predchádza sa nahnevaným zákazníkom, ktorí si v dnešnej dobe tiež radi vybíjajú svoj hnev na sociálnych sieťach.
Interná a externá technická dokumentácia
Externá technická dokumentácia je určená pre zákazníka alebo pre používateľa produktu. Týmto sa zabezpečí, aby používateľ produkt správne naštartoval a aby si v prípade akýchkoľvek problémov mohol najskôr prečítať dokumentáciu. Technickú dokumentáciu pre zákazníka spravidla vypracúvajú špeciálni editori. Ak sa produkt predáva na medzinárodných trhoch, texty musia byť odborne preložené do príslušných jazykov jednotlivých krajín. Napríklad v rámci Európy sú to angličtina, španielčina, poľština a švédčina. Externá technická dokumentácia je v závislosti od produktu a cieľovej skupiny známa skôr ako prevádzkový návod, návod na použitie alebo užívateľská príručka.
Osobitne dôležitá je profesionálna práca pri vytváraní dokumentácie. Napriek použitému technickému jazyku by mal mať používateľ niekoľko problémov s porozumením návodu na obsluhu. Okrem zrozumiteľnosti textov je samozrejme potrebné dodržať štýl a gramatické pravidlá. Okrem štandardnej dokumentácie na papieri, ktorá je priložená ku každému produktu, má zmysel pre zákazníka poskytovať online verzie. To ušetrí používateľovi dlhé hľadanie, ak sa pôvodné pokyny stratili. Práca s profesionálnym redakčným systémom na vytváraní dokumentácie má veľa výhod. Redakcia je dokonale vyškolená v písaní takýchto textov a je si istá svojím štýlom písania. Rozoznávate dôležité informácie a môžete ich efektívne zhrnúť ako dokument. Použitie externých rypákov šetrí čas a peniaze. Ďalej si môžete byť istí, že dokumentácia je implementovaná v súlade so všetkými bežnými pokynmi a špecifikáciami.
diskusia
Prihlásiť sa na odber komentárov (RSS)
2 komentáre k „Technickej dokumentácii: Viac ako návod na obsluhu“.
Pre mňa ako samostatného vývojára (softvér) je nepríjemné vytváranie dokumentácie tiež príležitosťou pozrieť sa na môj program (ešte raz) z pohľadu budúceho používateľa.
Pokiaľ je to možné, vedomosti z fázy tvorby dokumentácie by mali byť schopné prúdiť do produktu; pretože často len vtedy, keď chcete alebo musíte vysvetliť svoj produkt laikovi, spoznáte, kde je problém a čo sa mohlo vyriešiť príliš komplikovaným spôsobom.
Väčšie spoločnosti preto potrebujú možnosť spätnej väzby od autora pokynov pre vývojárov.
Prípadne by ste mali do procesu vývoja čo najskôr zahrnúť autorské hľadisko.
Len nedávno som zažil skutočný megaplavák s nedostatkom dokumentácie: Kúpil som si skvelý vaporizér/nádrž pre svoje elektronické výpary, ale nebolo popísané, ako je regulovaný odtok a prítok kvapaliny. Diel som poslal späť, pretože som zistil, že je „zamknutý“ na vrchu - hoci by to mal byť Topfiller! Potom som dostal časť späť a hľa: tam, kde bolo všetko zatvorené, som zrazu uvidel otvory ... všetko ok?
V žiadnom prípade! Plniace otvory opäť zmizli, keď som sa o to pokúsil nabudúce ... Skrátka: trvalo mi dlho, kým som sa dostal na trať. Diel mal skutočne dômyselnú mechaniku na otváranie a zatváranie týchto prítokových otvorov. Bohužiaľ, nie je zrozumiteľné a NEDOKUMENTOVANÉ!
Výsledok: produkt sa momentálne predáva. Určite si s ním nikto neporadí bez problémov ...