- kvalitní dokumentace k SW je vyžadovaným STANDARDEM. vzájemná provázanost SW (IS) ve velkých společnostech. aktuální přehledná srozumitelná

Transkript

1 DOKUMENTACE K SOFTWARU - kvalitní dokumentace k SW je vyžadovaným STANDARDEM - důvody: vzrůstající složitost SW (IS) vzájemná provázanost SW (IS) ve velkých společnostech - smysl má taková dokumentace která je: aktuální přehledná srozumitelná - umožňuje opravovat či modifikovat programy bez chyb - umožňuje snadno ověřovat správnost implementace - umožňuje sledovat průběh prací SPŠ na Proseku 7-1 Ing. Lukáš Procházka

2 DOKUMENTACE K SOFTWARU - důvody pro vytváření dokumentace jsou i zákonné: zákon č. 634/1992 Sb. zákon o ochranně 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é. standard ISVS - pro náležitosti životního cyklu informačního systému (ÚVIS) - zejména ve veřejné správě: - MVČR - Jihočeský kraj SPŠ na Proseku 7-2 Ing. Lukáš Procházka

3 DOKUMENTACE K SOFTWARU - doporučení pro vytváření dokumentace jsou uvedeny v: norma ČSN ISO uživatel. dokumentace a informace na obalu zákaznických softwarových balíků - poskytuje všechny informace potřebné k instalaci SW - poskytuje všechny informace potřebné k provozování SW normy IEEE - IEEE Standard for Software and System Test Documentation - norma specifikuje formu a množinu dokumentů pro použití v testování softwaru (ve všech 8 fázích) SPŠ na Proseku 7-3 Ing. Lukáš Procházka

4 DOKUMENTACE K SOFTWARU - důvody pro vytvář. dokumentace jsou z pohledu dodavatele: zrychlení úprav a změn SW (IS) předávání SW do provozu zastupitelnost klíč. zaměstnanců zrychlení tréninku uživatelů ušetření kapacit (expertů) - důvody pro vytvář. dokumentace jsou z pohledu zákazníka: snížení nákladů na zaškolení vyšší efektivita používání SW (IS) snížení nákladů na přímou podporu řešení problém. situací zjednodušené nasazení SW (IS) eliminace chyb uživatelů SPŠ na Proseku 7-4 Ing. Lukáš Procházka

5 DOKUMENTACE K SOFTWARU - výhody profesionálně zpracované dokumentace - dokumentaci zpracována dokumentarista - z jazykového hlediska: vysoká stylistická úroveň grafická správnost jazyková správnost - z odborného hlediska: jednotná a srozum. terminologie jasně popsané pracovní postupy logický a struktur. výklad - z personálního hlediska: uvolnění kapacit (programátor, analytik, ) SPŠ na Proseku 7-5 Ing. Lukáš Procházka

6 UŽIVATELSKÁ DOKUMENTACE - uživatelská dokumentace obsahuje detailní popis systému - skládá se ze dvou hlavních částí referenční popis - popis uživatelského rozhraní - popis základních objektů, ovládacích prvků (vč. významu) popis uživatelských postupů - popis základních postupů a procesů aplikace (systému) SPŠ na Proseku 7-6 Ing. Lukáš Procházka

7 NÁVAZNOST - postup v dokumentaci musí být logicky návazný Obr. 1 pro vytisknutí dokumentu vyberte možnost Tisknout Obr. 2 výběr tiskárny Obr. 3 pro změnu nastavení tiskárny vyberte možnost Vlastnosti SPŠ na Proseku 7-7 Ing. Lukáš Procházka

8 OBRÁZKY A NÁVAZNOST NA TEXT - obrázky musí navazovat na text a musí být logicky popsány - další postup je vhodné v obr. zvýraznit (ukazatel, ohraničení) Pro tisk dokumentu vyberte v menu Soubor možnost Tisknout (CTRL+P). Obr. 34 dialogové okno pro nastavení tisku Obr. 2 v menu Soubor vyberte možnost Tisknout, následně se otevře dialogové okno SPŠ na Proseku 7-8 Ing. Lukáš Procházka

9 UŽIVATELSKÁ DOKUMENTACE - doporučení při tvorbě uživatelské dokumentace: kapitoly - vzájemně navazující kapitoly - možnost vytištění dokumentace jako běžného manuálu hypertextové odkazy - možnost okamžitého otevření příslušného oddílu použití obrázků - použití obrázků postihující popisované situace - logická návaznost obrázků SPŠ na Proseku 7-9 Ing. Lukáš Procházka

10 ADMINISTRÁTORSKÉ PŘÍRUČKY - struktur. příručky určené administrátorům a operátorům - skládají se zpravidla z hlavních bloků: definice základních pojmů charakteristika a popis systému popis instalace konfigurace systému data a související procesy harmonogram zpracování údržba systému monitorování systému bezpečnost systému SPŠ na Proseku 7-10 Ing. Lukáš Procházka

11 NÁVAZNOST - postup v dokumentaci musí být logicky návazný Obr. 1 po spuštění instalace vyčkejte na extrahování instalačních souborů Obr. 2 vyberte cílovou složku instalace a stiskem na volbu Další zahájíte instalaci Obr. 3 zvolte možnost aktualizací aplikace softwaru (doporučeno volit volbu 1) Obr. 4 vyčkejte na dokončení instalace Obr. 5 instalace softwaru byla dokončena, ukončete stiskem tlačítka Dokončit SPŠ na Proseku 7-11 Ing. Lukáš Procházka

12 OBRÁZKY A NÁVAZNOST NA TEXT - obrázky musí navazovat na text a musí být logicky popsány - další postup je vhodné v obr. zvýraznit (ukazatel, ohraničení) Doporučení: instalační složku neměňte, ponechte výchozí C:\ProgramFiles Obr. 2 zmáčknutím další pokračujte Obr. 2 vyberte cílovou složku instalace a stiskem na volbu Další zahájíte instalaci aplikace SPŠ na Proseku 7-12 Ing. Lukáš Procházka

13 ADMINISTRÁTORSKÉ PŘÍRUČKY definice základních pojmů - slovník použitých pojmů a zkratek (viz. textová dokumentace) charakteristika a popis systému - seznámení s jednotlivými částmi systému (architekturami, ) konfigurace systému - přehled nutných (možných) nastavení bezpečnost systému - popis mechanizmu zabezpečení jednotlivých částí systému - popis způsobu logování přístupu SPŠ na Proseku 7-13 Ing. Lukáš Procházka

14 ADMINISTRÁTORSKÉ PŘÍRUČKY popis instalace - přehled HW a SW požadavků - návody na instalaci a seznam instalovaných souborů Požadavky na hardware: Základní systémové požadavky: Procesor Intel Core 2 Duo a vyšší CPU Intel pentium 4/AMD Athlon 64 Paměť 1 GB (doporučeno 4 GB) Paměť 512 MB (doporu4eno 1 GB) Graf. karta 2 GB HDD VGA 3 GB volného místa rozlišení 1024x768/32-bit Požadavky na software: Porty 1x USB 2.0 Operační systém Windows XP SP3 Windows Vista 32/64-bit Windows 7 32/64-bit MAC OS 9.0 a vyšší... OS Windows XP SP3, Windows 7 SW Microsoft Internet Explorer 6 Microsoft Media Player 9 SPŠ na Proseku 7-14 Ing. Lukáš Procházka

15 ADMINISTRÁTORSKÉ PŘÍRUČKY data a související procesy - přehled zdrojových a cílových dat, uložených procedur - popis všech hlavních procesů harmonogram zpracování - přehled a popis jobů údržba systému - seznam vykonávaných aktivit nutných pro chod systému - seznam známých problémů a postupy řešení monitorování systému - postupy a nastav. nutné pro monitorování činností systému SPŠ na Proseku 7-15 Ing. Lukáš Procházka