Představení oboru SW dokumentace
Proč vytvářet dokumentaci
Jak se obvykle dokumentace vytváří
Jak se dokumentace vytváří profesionálně
Představení oboru SW dokumentace
| ▪ | Obor softwarové dokumentace představuje rychle se rozvíjející disciplínu, využívající moderních přístupů a technologií. Postihuje všechny oblasti dokumentovaného produktu, od dokumentace uživatelské a provozní, až po dokumentaci technickou a programovou. |
| ▪ | Kvalitní dokumentace k SW se stává vyžadovaným standardem z důvodu rychle vzrůstající složitosti informačních systémů a jejich vzájemné provázanosti ve velkých společnostech. |
|
|
Proč vytvářet dokumentaci
Protože bychom měli…
| ▪ | Zákon č. 634/1992 Sb., o ochraně spotřebitele §9 odst. 1:... je prodávající povinen zajistit, aby tyto informace byly obsaženy v přiloženém písemném návodu a aby byly srozumitelné. |
| ▪ | ČSN ISO 9127 – Uživatelská dokumentace a informace na obalu zákaznických softwarových balíků. |
| ▪ | Standard ISVS pro náležitosti životního cyklu informačního systému (ÚVIS). |
Protože potřebujeme...
| ▪ | Trvá přeměna nováčka ve zkušeného uživatele systému dlouho? |
| ▪ | Čerpají nováčci v procesu zaškolení příliš kapacitu našich specialistů? |
| ▪ | Bojíme se o zastupitelnost po odchodu klíčových zaměstnanců? |
| ▪ | Jsou naše systémy dobře zdokumentované? |
| ▪ | Netrvají jejich změny a úpravy příliš dlouho? |
| ▪ | Máme problémy s předáváním produktů do provozu? |
| ▪ | Je naše dokumentace srozumitelná cílovým skupinám a uživatelským rolím? |
| ▪ | Nabízíme vlastní softwarové řešení. Je dokumentace tohoto řešení také konkurenceschopná? |
| ▪ | Splňuje naše dokumentace základní normy? |
Protože chceme...
| ▪ | Sníží náklady na zaškolení a na přímou podporu uživatelů. |
| ▪ | Zjednoduší a sníží náklady na nasazení systému. |
| ▪ | Usnadní zastupitelnost uživatelů systému. |
| ▪ | Zefektivní používání systému. |
| ▪ | Eliminuje možné chyby uživatelů. |
| ▪ | Nabídne řešení problematických situací. |
| ▪ | Poskytne podklady pro další efektivní rozvoj systémů. |
|
|
|
Jak se obvykle dokumentace vytváří
| ▪ | Tvorba probíhá „náhodně“, dokumentace nemá předem definovanou strukturu. |
| ▪ | Nestrukturovaný text (MS Word) bez klíčových slov, rejstříku. |
| ▪ | Textu dobře rozumí většinou jen sám autor (vývojář, analytik), ne už však uživatel. |
| ▪ | Jen formalita kvůli předání do provozu (nikoliv užitečná pomůcka). |
| ▪ | Tvorba dokumentace ubírá kapacity důležitým zdrojům. |
Důsledky:
| ▪ | Částečně zdokumentované interní systémy, jejich další rozvoj trvá dlouho a je závislý na klíčových zaměstnancích. |
| ▪ | Uživatelé systémů potřebují dlouhou dobu na zaškolení se v systému, ubírají kapacity zkušeným (klíčovým) uživatelům systémů. |
| ▪ | Společnosti se bojí odchodu těchto klíčových vývojářů, administrátorů, uživatelů. |
| ▪ | Ve velkých společnostech vznikají nová oddělení, která mají za úkol popisovat práci se systémem. |
| ▪ | Provozní oddělení mají problémy spravovat interní systémy a jejich nové verze, proto správa zůstává v rukou klíčových vývojářů, kterým to opět ubírá kapacity. |
|
Jak se dokumentace vytváří profesionálně
| ▪ | Dokumentace je vyhotovena profesionálně, tedy kvalitně a efektivně. |
| ▪ | Zaručuje jazykovou, stylistickou i grafickou správnost. |
| ▪ | Dokumentarista dokáže uživateli pracovní postupy popsat jasně, za použití jednotné a srozumitelné terminologie. |
| ▪ | Dokumentarista umí prostý popis aplikace obohatit o logický a strukturovaný výklad. |
| ▪ | Alokací dokumentaristy se uvolní pozice zastávající tvorbu dokumentace nad rámec svého zaměření (programátoři, analytici, konzultanti…). |
| ▪ | Dokumentarista působí v procesu vývoje produktu též jako koordinátor a korektor vstupů/podkladů pro vytvoření dokumentace. |
|
