Tvorba softwarové dokumentace

Transkript

1 Jiří Roun - Tvorba softwarové dokumentace Tvorba softwarové dokumentace Nabídka služeb Verze:

2

3 Obsah 3 Obsah O oboru... 5 Představení oboru... SW dokumentace 5 Proč vytvářet dokumentaci... 5 Jak se obvykle... dokumentace vytváří 6 Jak se dokumentace... vytváří profesionálně 6 O mně... 8 Reference... Aktuálně... Adastra s.r.o Logos, a.s Eurotel, s.r.o Arbes Technologies,... s.r.o. 13 Curriculum Vitae Přehled zkušeností Vzdělání Školení absolvovaná... v poslední době 15 Průběh zaměstnání Jazykové znalosti Jiné schopnosti... a dovednosti 18 Výpis z živnostenského... rejstříku 1 Osvědčení o registraci Nabídka... služeb 21 Nabízené typy... dokumentace 22 Uživatelské... příručky 22 Instalační manuály Administrátorské... a provozní příručky 24 Technická... a programová dokumentace 26 Nabízené formáty... dokumentace 27 Základní formáty Další možné Ukázky formátů Kompilovaná hypertextová... nápověda 28 Funkce Internetová verze... nápovědy 32 Tištěná dokumentace Dokumentace ve... formátu PDF 34 Dokumentace ve... formátu MS2Help 35 Dokumentace ve... formátu Window s Help 36 Dokumentace ve... formátu JavaHelp 37 Manuály versus elektronické... příručky 38 Nabídka ostatních... služeb 3 Kontakty Adresa Mobil ISDS Fakturační údaje... 41

4 4 Jiří Roun, Tvorba softwarové dokumentace

5 SW dokumentace 5 SW dokumentace O oboru 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/12 Sb., o ochraně spotřebitele 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 127 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é konkurenceschopná? řešení. Je dokumentace tohoto řešení také Splňuje naše dokumentace základní normy?

6 6 Jiří Roun, Tvorba softwarové dokumentace 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ě Pomocí dokumentaristy. Dokumentace je vyhotovena profesionálně, tedy kvalitně a efektivně.

7 SW dokumentace 7 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.

8 8 Jiří Roun, Tvorba softwarové dokumentace O mně Tvorbě softwarové dokumentace (IT profese Technical Writer) se věnuji osmnáct let. Své znalosti o oboru jsem začal čerpat ve společnosti Arbes Technologies, zkušenosti pak postupně rozvíjet ve společnostech Logos, Eurotel a Adastra. Disponuji: vhodně zvolenými nástroji a propracovanými postupy, lety a praxí zdokonalovaným know-how, výborným technickým zázemím, časovou flexibilitou. Opírám se o: osvědčené metodiky, kvalitně připravené standardy, ověřené pracovní postupy, technické a technologické znalosti, dlouholeté zkušenosti a praxi. Viz též Nabídka služeb, Kontakty a Fakturační údaje.

9 SW dokumentace Reference Některé realizované projekty. Aktuálně Zákazník Principal engineering s. r. Test analýza projekty Windsor, Trinity, EÚvěr, IFRS a o. další Raiffeisenbank a. s. Testování na úrovni SIT Příprava dat Komerční banka a. s. Business analýza, test analýza i test design pro aplikaci WebGarant Penzijní společnost České Uživatelská a referenční dokumentace k systému Český pojišťovny a. s. produkční II. NESS Czech, s. r. o. Česká spořitelna a. s. Test analýza, testování na úrovni FAT a UAT, referenční dokumentace projekt Klid, aplikace espis INTERIS CZ, a. s. Uživatelská dokumentace, test analýza a testování na úrovni UAT projekt Podpora provozu Zemědělského registru LPIS Multima a. s. Uživatelská dokumentace projekty Rezervační systém Pyxis a Research Samples SIKS a. s. Analytické práce pro systém CRV Testování systému CRV Uživatelská dokumentace k systému CRV Školení systému CRV E-learning k systému CRV Microsoft Referenční dokumentace k webovým službám projekt MPSV-Integrační služby BizTalk NESS Czech, s. r. o. Test analýza, testování na úrovni SIT projekt Portals II

10 10 Jiří Roun, Tvorba softwarové dokumentace Zákazník ING Management Services s. r. o. ADASTRA s. r. o. Raiffeisenbank a. s. Automatizované testování projekt Everest-Datová migrace ADASTRA s. r. o. Uživatelská příručka pro aplikaci Micros Financování Česká spořitelna a. s. Provozní dokumentace k systému Micros Testování systému na úrovni SIT a UAT Uživatelská příručka k systému Brasil Mainstream Technologies, Uživatelská příručka pro aplikaci postregistr.cz s. r. o. Příprava testovacích scénářů Testování Mainstream Technologies, Referenční příručka pro SUBTERRA Intranet Portál s. r. o. stavby Subterra a. s. Uživatelská příručka pro SUBTERRA Intranet aplikace Smlouvy Uživatelská příručka pro SUBTERRA Intranet aplikace Vyúčtování mobilních služeb a posteriori.cz s. r. o. Uživatelská příručka pro aplikace Prométheus, Hermés a ExtNet ICZ a. s. Uživatelské příručky pro aplikace SDP2, Autorizace, Předzpracování, Šablonátor Administrátorský manuál k systému Správa dopravních přestupků Systémová dokumentace a instalační manuál pro systém Správa dopravních přestupků Testovací scénáře pro testování systému Správa dopravních přestupků AutoCont CZ a. s. Uživatelská příručka pro aplikaci etesty Uživatelská příručka pro systém SVI 2008 Uživatelská příručka pro aplikaci E.ON IT Manager Reporty

11 SW dokumentace 11 Zákazník Uživatelská příručka pro aplikaci Valeo CSK DATASYS Software, s. r. o. Uživatelské, administrátorské a instalační příručky k produktům VoiceChange, CallChange, MobilChange, FaxChange a WorkMate DATASYS s. r. o. Uživatelská příručka pro aplikaci DEPO DATASYS s. r. o. Uživatelská příručka k aplikaci PNC Česká pošta Administrátorská a provozní dokumentace k systému PNC Analytické práce pro systém e-tržiště CleverApp. s. r. o. Uživatelská příručka pro aplikaci MARKTIME Dignita, s. r. o. Uživatelská příručka pro aplikaci Recomando Uživatelská a administrátorská příručka pro aplikaci epodatelna Videotutoriál k aplikaci epodatelna Za Adastra s. r. o. Zákazník Tipsport a. s. Uživatelská a provozní příručka pro systém TipV4 ČSOB Pojišťovna a. s. Uživatelská a provozní příručka pro systém Campaign Management Česká pojišťovna a. s. Administrátorská příručka pro systém CCD Telefónica O2 Republic, a. s. Tatra banka, a. s. Czech Referenční popis ETL procesů (mapování a workflow) v architektuře Global Data Warehouse Uživatelská příručka pro nástroj Query Selection Tool

12 12 Jiří Roun, Tvorba softwarové dokumentace Za Logos, a. s. Zákazník Eurotel, s. r. o. Uživatelská a administrátorská příručka, programová dokumentace pro systém Campaign Management CzechTrade Uživatelská a administrátorská příručka pro Redakční systém BusinessInfo FISCHER a. s. Uživatelská příručka pro Rezervační systém Fischer AutoCont a. s. Uživatelská příručka pro ASDW (aplikace pro správu domény) British Telecom Uživatelská příručka pro aplikaci OHS Wincor Nixdorf Uživatelská příručka pro servisní informační systém Call Center Desk Wincor Nixdorf Uživatelská příručka pro aplikaci ProAdmin ŠKODA AUTO a. s. Uživatelská příručka pro aplikaci Routeplanner ŠKODA AUTO a. s. Sada uživatelských příruček pro systém Centria ŠKODA AUTO a. s. Uživatelská příručka pro dealerský systém Wilson Siemens s. r. o. Uživatelské a provozní příručky pro systém E-Tool SONY Czech, spol. s r.o. Uživatelská příručka pro aplikaci Correspondent Contactel s. r. o. Uživatelská příručka pro aplikaci CRM Gate etel s. r. o. Uživatelská příručka pro aplikaci OHS Home Credit a. s. Uživatelská příručka pro aplikaci IDM Dexia banka Slovensko a. Uživatelská příručka pro systém Home Banking s. COOP Centrum družstvo Uživatelská a administrátorská příručka pro Obchodní portál COOP

13 SW dokumentace 13 Zákazník Patria Online, a. s. Referenční příručka pro Patria Internet Pro Eurotel, s. r. o. Uživatelská příručka pro modul CoutnerImport BIS Portálu Uživatelská příručka pro aplikaci Database Manager Uživatelská a programová příručka pro aplikaci DevMan Uživatelská příručka pro modul EditCounterEditor BIS Portálu Uživatelská příručka pro aplikaci Eurotel Metadata Editor Administrátorská příručka pro systém Eurotel Warehouse of CDR Administrátorská a programová příručka pro systém Fraud Detection System Administrátorská a programová příručka pro systém File Input Handler Uživatelská příručka pro systém ISOLA Pro Arbes Technologies, s. r. o. Uživatelská příručka pro aplikaci Senior Uživatelská příručka pro systém Leasing Uživatelská příručka pro aplikaci Faktoring Uživatelská příručka pro aplikaci MIS Uživatelská příručka pro systém KDP

14 14 Jiří Roun, Tvorba softwarové dokumentace Curriculum Vitae Jiří Roun * Přehled zkušeností Cca 18 let praxe v tvorbě uživatelské, provozní, administrátorské a programové dokumentace Zkušenost s řízením týmu SW dokumentaristů Zkušenost s přípravou e-learningových prezentací a videotutoriálů Praxe ve školení koncových uživatelů informačních systémů Zkušenost s přípravou a údržbou testovacího prostředí Praxe v přípravě testovacích scénářů a zkušenosti s automatizovaného) testováním (včetně Praxe v business analýze Praxe ve správě a designu firemního portálu Zkušenost se správou řízené dokumentace Zkušenost se psaním metodik Praxe v sestavování nabídek a v jejich fyzické kompletaci Znalost principů SEO Znalost UML Základní znalost SQL Znalost RUP, zkušenosti také s agilním vývojem

15 SW dokumentace 15 Vzdělání Škola Gymnázium Jana Keplera, Praha Rok ukončení 184 Školení absolvovaná v poslední době Společnost Školení LBMS Objektová analýza a návrh UML GOPAS Microsoft Office SharePoint Server 2007 návrh, plánování a správa Krauthammer International Vyjednávání

16 16 Jiří Roun, Tvorba softwarové dokumentace Průběh zaměstnání Rok Zaměstnavatel ADASTRA, s. r. o., Karolinská 2, Praha 8 Zařazení Senior dokumentarista, správce firemního portálu Pracovní náplň Tvorba různých typů a formátů dokumentace k SW produktům Příprava a pořádání workshopů a školení z oblastí oboru tvorby dokumentace (procesy, pravidla, typografie, grafika, ) Kompletace nabídek Správa a vývoj firemního intranetu (na MS Office SharePoint Server 2007) Správa a editace firemního čtrnáctidenníku Viz též Reference Rok 2005 Zaměstnavatel Eurotel, s. r. o., Vyskočilova 1b, Praha 4 Zařazení Dokumentarista, IT specialista Pracovní náplň Tvorba různých typů a formátů dokumentace k SW produktům Viz též Reference Rok Zaměstnavatel Logos, a. s., Vyskočilova 4, Praha 4 Zařazení Dokumentarista vedoucí týmu Pracovní náplň Vedení týmu SW dokumentaristů (veškerá agenda + přijímací a hodnotící pohovory)

17 SW dokumentace 17 Tvorba různých typů a formátů dokumentace k SW produktům Příprava a pořádání workshopů a školení z oblastí oboru tvorby dokumentace (procesy, pravidla, typografie, grafika, ) Viz též Reference Rok Zaměstnavatel ARBES Technologies, s. r. o., Štefánikova 32, Praha 5 Zařazení Dokumentarista Pracovní náplň Tvorba různých typů a formátů dokumentace k SW produktům Viz též Reference Rok 13 1 Zaměstnavatel PVT, a. s., Podvinný mlýn 6, Praha Zařazení Vedoucí Střediska služeb PVT Pracovní náplň Vedení Střediska služeb PVT (v rámci střediska pracovalo např. Obchodní místo RM-Systému či pobočka zdravotní pojišťovny ČNZP a pobočka Penzijního fondu Živnostenské banky) Rok Zaměstnavatel Vodní Stavby Praha, a. s. Zařazení Izolatér Rok Zaměstnavatel T.J. Lokomotiva Vršovice, Praha Zařazení Jezdec, ošetřovatel koní

18 18 Jiří Roun, Tvorba softwarové dokumentace Jazykové znalosti Jazyk Stupeň znalosti Čeština Rodilý mluvčí Ruština Pokročilý Angličtina Středně pokročilý Jiné schopnosti a dovednosti Operační systémy DOS, Windows (2000, NT, x, XP, Vista, 7, 8, 10), Windows Server 2003/2008/2012, Linuxové distribuce Jazyky SQL, JavaScript, HTML, CSS, XML, znalost prostředí a syntaxe MediaWiki CASE MS Visio, Enterprise Architect, Bizgi Process Modeler Ostatní MS Office, MS FrontPage, MS SharePoint Designer, SharePoint Server 2003, MS Office SharePoint Server 2007 Grafické programy: Adobe Photoshop, Corel PaintShop Pro, CorelDraw, SmartDraw Nástroje pro tvorbu dokumentace a interaktivních průvodců: Html Help WorkShop, Help & Manual, RoboHelp, Adobe Captivate, TechSmith Camtasia Studio, NDoc, SandCastle Help File Builder, PlDoc, SnagIt, XML Mind XML Editor, SnagIt Virtualizační nástroje: VMware Workstation, MS Virtual PC, Oracle Virtual Box Systémy bug trackingu: etraxis, BugZilla), HP Quality Center (ALM), SPIRA Team, TestLink Verzovací systémy: MS SourceSafe, SVN, CVS Další: PL/SQL Developer, Oracle SQL Developer, SQL Server Management Studio, soapui (testování webových a REST služeb) Řidičský průkaz B

19 SW dokumentace 1 Výpis z živnostenského rejstříku

20 20 Jiří Roun, Tvorba softwarové dokumentace Osvědčení o registraci

21 SW dokumentace 21 Nabídka služeb Disponuji propracovaným know-how a zkušenostmi pro pokrytí celé oblasti softwarové dokumentace. Nabízím vytvoření různých typů a formátů dokumentace, přesně podle konkrétních potřeb zákazníka. Profesionální kvalitu poskytuji při: o tvorbě uživatelské dokumentace k softwarovým produktům; o vyhotovení administrátorských a provozních příruček bezproblémové nasazení, parametrizaci a provoz systémů; umožňujících o vytváření instalačních manuálů; o zpracování programové dokumentace pro snadnou zastupitelnost vývojového týmu a zpětnou úpravu a vývoj programového kódu. Viz Nabízené typy dokumentace a Nabízené formáty dokumentace. Viz též Nabídka ostatních služeb. Výstupy dokumentace splňují standard ISVS pro náležitosti životního cyklu informačního systému (ÚVIS). Metodika tvorby dokumentace vychází z metodiky vývoje software RUP. Elektronické příručky lze chápat zároveň jako klasický help i strukturovaný manuál. Jsou též připraveny pro kontextové připojení. Příručky obsahují precizně naplněný rejstřík, fulltextové vyhledávání. Podpora více operačních systémů. Zdroje dokumentace jsou snadno převoditelné do dalších formátů. HTML výstupy jsou W3C validní. Dokumentace umožňuje průběžné připomínkování.

22 22 Jiří Roun, Tvorba softwarové dokumentace Nabízené typy dokumentace Uživatelské příručky Uživatelská příručka obsahuje detailní uživatelský popis aplikace/systému, zpravidla složený ze dvou hlavních bloků: Referenční popis uživatelského rozhraní, včetně všech základních objektů a ovládacích prvků, jejich významu a způsobu použití (připravený též pro kontextovou nápovědu); Popis uživatelských postupů, jenž provede uživatele (dle rolí) všemi základními postupy a procesy v aplikaci/systému. Členěna je na vzájemně navazující kapitoly. Tím je umožněno vytištění dokumentace jako běžného manuálu. Pomocí hypertextových odkazů lze příslušný oddíl dokumentace otevřít okamžitě, aniž by bylo nutné prohlížet jednotlivé stránky před vybraným místem. Dokumentace je bohatě vybavena obrázky, postihujícími dané situace. Jednotlivé obrázky na sebe logicky navazují. Příručku lze chápat jako strukturovaným manuálem. interaktivní nápovědu aplikace, zároveň je však i Ukázka uživatelské dokumentace

23 SW dokumentace 23 Instalační manuály Ukázka instalačního manuálu

24 24 Jiří Roun, Tvorba softwarové dokumentace Administrátorské a provozní příručky Administrátorské a provozní příručky administrátorům a operátorům systému. jsou strukturované příručky určené Příručky obsahují zpravidla tyto základní bloky: Definice základních pojmů Slovník pojmů a zkratek použitých v příručce, jejichž znalost je nutná pro pochopení obsahu; Charakteristika a popis systému Seznamuje s jednotlivými součástmi systému (Aplikační architektura, Integrační architektura, Infrastruktura,...); Popis instalace Přehled HW a SW požadavků jednotlivých částí systému, návody instalací a seznam instalovaných souborů; Konfigurace systému Nabízí přehled všech nutných nastavení; Bezpečnost systému Popis mechanismu zabezpečení jednotlivých částí systému a způsob logování přístupů; Data a související procesy Obsahuje přehled zdrojových i cílových dat, uložených procedur, popis všech hlavních procesů; Harmonogram zpracování Obsahuje přehled a popis jobů; Údržba systému Seznam nutných aktivit, které je nutné vykonávat pro zajištění bezproblémového běhu systému. Seznam známých problémů a postupy jejich řešení; Monitorování systému Postupy a nastavení nutné pro monitorování činnosti systému; a další informace nutné pro aplikace/systému v provozu. bezproblémovou instalaci, nasazení a udržování Ukázka administrátorské dokumentace Ukázka provozní a administrátorské dokumentace

25 SW dokumentace 25 Ukázka provozní dokumentace

26 26 Jiří Roun, Tvorba softwarové dokumentace Technická a programová dokumentace Programová dokumentace obsahuje programového kódu aplikace/systému: přesnou a důkladnou dokumentaci z velké části je generována automaticky přímo z programového kódu; umožňuje vzájemnou zastupitelnost členů týmu i pozdější pokračování ve vývoji, úpravy a rozvoj aplikace/systému; vyžaduje (zároveň kontroluje) vývojáři správně komentovaný programový kód. Referenční programová dokumentace Ukázka programové dokumentace

27 SW dokumentace 27 Nabízené formáty dokumentace Všechny základní nabízené typy dokumentace (uživatelská, administrátorská, programová dokumentace) mohou být dodávány v různých formátech. Základní formáty Zdroje dokumentace jsou psány v XML, což umožňuje z jednoho zdroje vytvořit dokumentaci v následujících základních formátech: *.chm (MS Help 1.x) *.htm/*.html (pro web i mobilní zařízení) *.doc/*docx *.PDF WinHelp MS Help 2 Další možné Dle přání zákazníka je možné dodat i další formáty dokumentace. Například: JavaHelp OracleHelp epub MOBI Ukázky formátů Jednotlivé podoby různých forem dokumentace se vzhledem k různým technologiím zpracování liší, ovšem vzhledem k ovládání (elektronické formy) a struktuře (všechny formy) jsou vzájemně kompatibilní tak, aby uživateli poskytovaly obdobnou úroveň komfortu, tedy možnost orientace v dokumentaci a rychlost vyhledání požadované informace.

28 28 Jiří Roun, Tvorba softwarové dokumentace Kompilovaná hypertextová nápověda Kompilovaná hypertextová nápověda ve formě souboru CHM (MS Help 1.x) je vhodná zejména pro aplikace typu tlustý klient, na které je možné ji kontextově napojit. Lze ji využít i jako nekontextovou nápovědu k aplikacím typu tenký klient, kde je ovšem nevýhodou kompaktní podoba jednoho souboru, který musí být v případě potře-by z příslušného portálu celý stažen. Kompilovaná hypertextová nápověda v textového okna s požadovanou informací uživatel orientuje a pohybuje v rámci kontextové navázání na aplikaci, což komfortu při vyhledávání informací. podobě souboru CHM poskytuje kromě také dva základní ovládací prvky, jimiž se nápovědy. Kromě nich je připravena na poskytuje nejvyšší úroveň uživatelského V rámci nápovědy jsou využity pro snadné vyhledávání informací hypertextové odkazy, pro zvýšení přehlednosti pak vyklápěcí obrázky. Ukázka formátu Funkce Ovládací nástrojová lišta Ovládací nástrojová lišta v horní části okna nápovědy poskytuje ovládací prvky podle standardů prohlížeče Internet Explorer, který je také pro prohlížení jednotlivých témat využit. Tlačítko Previous (Předchozí) Umožňuje vertikální pohyb zpět ve stromové struktuře obsahu nápovědy. Supluje tak listování v tištěné podobě dokumentace pohybem proti směru logické návaznosti textu.

29 SW dokumentace 2 Tlačítko Next (Další) Umožňuje vertikální pohyb kupředu ve stromové struktuře obsahu nápovědy. Supluje tak listování v tištěné podobě dokumentace pohybem po směru logické návaznosti textu. Tlačítko Back (Zpět) Umožňuje návrat na předchozí prohlíženou stránku. Prohlížeč eviduje historii souslednosti prohlížených stránek dokumentace, tato funkce umožňuje pohyb v historii stránek směrem dozadu. Tlačítko Forward (Vpřed) Umožňuje návrat na předchozí prohlíženou stránku. Prohlížeč eviduje historii souslednosti prohlížených stránek dokumentace, tato funkce umožňuje pohyb v historii stránek směrem kupředu. Tlačítko Home (Domů) Návrat na domovskou stránku elektronické příručky s indexem hlavních odkazů do ucelených tematických celků dokumentace. Tlačítko Hide/Show (Skrýt/Odkrýt) Skrývá či odkrývá vyhledávací prvky v levé části okna elektronické příručky, čímž umožňuje v případě potřeby rozšířit plochu se zobrazenou informací. Tlačítko Locate (Najít) Synchronizuje vyhledanou informaci se stromem obsahu ve levé části nápovědy. Tlačítko Print (Tisk) Umožňuje vytisknout část nebo celou nápovědu. Vyhledávací prvky Vyhledávací prvky jsou soustředěny levé části okna nápovědy v podobě čtyř záložek poskytujících různé varianty způsobu vyhledání informace. Záložka Contents (Obsah) Poskytuje přehled všech stránek nápovědy ve stromové podobě. Obsah je vytvářen automaticky při tvorbě zdrojových souborů nápovědy. Záložka Index (Rejstřík) Poskytuje vyhledávání stránek prostřednictvím klíčových slov. Rejstřík je vytvářen při tvorbě zdrojových souborů nápovědy. Záložka Search (Vyhledávat) Prohledávání stránek obsahující specifikovaný text. Záložka Favorites (Oblíbené)

30 30 Jiří Roun, Tvorba softwarové dokumentace Umožňuje evidovat nejčastěji navštěvované stránky a rychlý přístup k těmto stránkám. Kontextové navázání na aplikaci Kompilovaný soubor hypertextové nápovědy může být kontextově napojen na příslušnou aplikaci, přičemž tato varianta připadá v úvahu u aplikací typu tlustý klient. Technika je stanovena samostatnou metodikou pro tvorbu dokumentace. Ostatní funkce Nápověda využívá podpůrných funkcí jazyka JavaScript a HTML Help API pro ošetření některých operací poskytujících zvýšený uživatelský komfort při prohlížení nápovědy. K nim patří zejména: Rozevírání obrázků Pro větší přehlednost jednotlivých stránek nápovědy je použita většina screenshotů ve formě výklopných obrázků, tzn. na stránce je pouze popis obrázku v podobě odkazu, který otevírá/zavírá obrázek. Možnost využití sekundárních oken Prostřednictvím funkcí HTML Help API lze vyžít několik typů vyvolání odkazů v sekundárních oknech, a to jak uvnitř, tak vně kompilované nápovědy. Spojování několika souborů nápovědy HTML Help Workshop umožňuje spojit několik samostatných souborů CHM tak, aby navenek vystupovaly jako jeden help (podobně jako např. MSDN). Technika využití výše zmíněných funkcí je stanovena samostatnou metodikou pro tvorbu dokumentace. Sekundární okna V rámci dokumentace ve formě kompilované hypertextové nápovědy lze využívat zobrazení informací v sekundárních oknech helpu, tj. tak, aby bylo možné souběžně získávat dvě různé informace ve dvou různých oknech. Funkčnost je k dispozici prostřednictvím funkcí HTML Help API. Požadavek na využití sekundárních oken je třeba specifikovat v analýze k příslušnému produktu, samotnou implementaci pak plně vykonává dokumentarista. Systém vzájemně provázaných souborů nápovědy V případě složitějších systémů modulárního typu, kdy je umožněn samostatný provoz jednotlivých modulů bez vzájemné provázanosti s moduly ostatními, lze vytvářet i dokumentaci pro každý modul samostatně. Jednotlivé takto vytvořené dílčí dokumentace je pak možné spojovat a vytvářet tak systém vzájemně provázaných souborů CHM složený ze samostatně existujících nápověd navenek vystupující jako jednolitá nápověda (viz např. systém helpů typu MSDN).

31 SW dokumentace 31 Požadavek na takto zpracovanou dokumentaci je třeba specifikovat v analýze k příslušnému produktu, samotnou implementaci pak plně vykonává dokumentarista. Uživatelská příručka ve formátu *.chm

32 32 Jiří Roun, Tvorba softwarové dokumentace Internetová verze nápovědy Internetová verze nápovědy využívá struktury zdrojových souborů dokumentace ve formě webiste a prostřednictvím rámcových i bezrámcových stránek prezentuje dokumentaci v nekompilované podobě s grafickým zpracováním podobným kompilované nápovědě. Je vhodná zejména jako nápověda aplikací typu tenký klient, pro které poskytuje dostatečný uživatelský komfort a možnost kontextového napojení. Díky technologickým rozdílům ve zpracování existují určité rozdíly a omezení oproti kompilované verzi. Ukázka formátu

33 SW dokumentace 33 Tištěná dokumentace Tištěná forma dokumentace představuje doplněk elektronických forem dokumentace, případně může být též zákazníkem smluvně vyžadována. Může být dodávána také v podobě souboru formátu MS Word, OpenOffice či PDF. Tištěná uživatelská příručka je zpracována dle standardů firemního CI s využitím zdrojů příruček elektronických. Dokumentace ve formátu MS Word Viz též Manuály versus elektronické příručky.

34 34 Jiří Roun, Tvorba softwarové dokumentace Dokumentace ve formátu PDF Klasická příručka ve formátu PDF. Navigace dle záložek, možnost zamykání dokumentu proti kopírování. Plná funkčnost hypertextových odkazů. Ukázka formátu

35 SW dokumentace 35 Dokumentace ve formátu MS2Help Dokumentace ve formátu MS2Help (MS Help 2.0). Integrována více do vývojového prostředí (Visual Studio.Net). Ukázka formátu

36 36 Jiří Roun, Tvorba softwarové dokumentace Dokumentace ve formátu Windows Help Standardní nápověda formátu *.hlp. Ukázka formátu

37 SW dokumentace 37 Dokumentace ve formátu JavaHelp Formát nápovědy pro Java aplikace. Vyžaduje framework pro zobrazování helpu v Java aplikacích. Systém JavaHelp je napsaný v Javě a je určený pro aplikace vytvářené v Javě. Poskytuje vývojářům a autorům standardní, plnohodnotný a snadno použitelný systém pro prezentování on-line informací uživatelům aplikací napsaných v Javě. Tento systém je rozšířením Java SDK a je k dispozici na JavaHelp systém umožňuje vývojářům zpřístupnit nápovědu: v aplikacích, v komponentách JavaBeans, v appletech. Ukázka formátu

38 38 Jiří Roun, Tvorba softwarové dokumentace Manuály versus elektronické příručky Tištěné příručky Jen jsou-li vyžadovány Složitá údržba u větších systémů Těžko aktualizovatelné Ekonomická náročnost Tisk Vazba Množení Distribuce Nedostatečný uživatelský komfort Elektronické příručky Uživatelský komfort Snadná aktualizace Snadná distribuce i elektronickou formou Možnost využití moderních technologií Možnost automatizace procesů Možnost modulárního zpracování

39 SW dokumentace 3 Nabídka ostatních služeb Z ostatních služeb nabízím: Přípravu školících materiálů Psaní metodik Vyhotovení prezentací Vytvoření interaktivních průvodců, videotutoriálů a e-learningových prezentací Poradenství a podpora v oblasti elektronického zpracování dokumentů (poradenství při zakládání týmů dokumentaristů, zaškolení, výběr nástrojů, zpracování metodiky) Copywriting Jazykové korektury Přípravu testovacích scénářů Testování aplikací Business analýzy Návrhy GUI, drátěné modely Poradenství při zavádění intranetových řešení postavených na technologii Microsoft SharePoint Tvorbu webových stránek E-learningová prezentace, rozcestník Videotutoriál Drátěný model Návrh GUI

40 40 Jiří Roun, Tvorba softwarové dokumentace Testovací scénář pro akceptační testování Use case

41 SW dokumentace 41 Kontakty Adresa Jiří Roun V průčelí 1652/ Praha 4 Chodov Mobil jiri.roun@swdokumentace.cz ISDS y8rqy6v Fakturační údaje Jiří Roun V průčelí 1652/ , Praha 4 Chodov IČ: DIČ: CZ Bankovní spojení: 21110/0600 Jsem plátcem DPH.

42 42 Jiří Roun, Tvorba softwarové dokumentace

43 Index Rejstřík -Aa posteriori.cz s. r. o. ADASTRA, s. r. o. 8,, 14 Administrátorské a provozní příručky Administrátorské příručky 22 Adobe Captivate 14 Adobe Photoshop 14 Adresa 41 Angličtina 14 Arbes Technologies 8, ASDW AutoCont CZ a. s. o. Autorizace -BBankovní spojení 41 Bezpečnost systému 22 BIS Portál Brasil British Telecom Bug tracking 14 Business analýzy 3 BusinessInfo -DData a související procesy 22 DATASYS Software s. r. o. Datová migrace Definice základních pojmů 22 DEPO DevMan Dexia banka Slovensko a. s. o. DIČ 41 Dignita, s. r. o. Dokumentace 5 Dokumentace ve formátu JavaHelp 37 Dokumentace ve formátu MS2Help 35 Dokumentace ve formátu PDF 34 Dokumentace ve formátu Windows Help DOS 14 DPH 41 -E- -CCallChange Campaign Management Camtasia Studio 14 CASE 14 CCD Centria CleverApp. s. r. o. Contactel s. r. o. COOP Centrum družstvo Copywriting 3 CorelDraw 14 Correspondent CoutnerImport CRM Gate CRV 22 CSS 14 Curriculum Vitae 14 CzechTrade Česká pojišťovna a. s. o. Česká pošta Česká spořitelna a. s. o. Čeština 14 ČNZP 14 ČSOB Pojišťovna a. s. o. E.ON IT Manager Reporty EditCounterEditor Elektronická podatelna Elektronické příručky etel s. r. o. etesty E-Tool etraxis 14 e-tržiště Eurotel 8, Eurotel Metadata Editor Eurotel Warehouse of CDR Eurotel, s. r. o., 14 EÚvěr 36 43

44 44 Jiří Roun, Tvorba softwarové dokumentace -F- -J- Faktoring Fakturační údaje 41 FaxChange File Input Handler FISCHER a. s. o. Formáty příruček 27 Fraud Detection System FrontPage 14 Fulltextové vyhledávání 21 Funkce 28 Jak se dokumentace vytváří profesionálně Jak se obvykle dokumentace vytváří 5 JavaHelp 37 JavaScript 14 Jazykové korektury 3 Jazykové znalosti 14 Jiné schopnosti a dovednosti 14 -K- Global Data Warehouse GOPAS 14 Gymnázium Jana Keplera 14 KDP Kompilovaná hypertextová nápověda Konfigurace systému 22 Kontakty 41 Korektury 3 Krauthammer International 14 -H- -L- Harmonogram zpracování 22 Help & Manual 14 Hermés Home Banking Home Credit a. s. o. HP Quality Center 14 HTML 14, 21 Html Help WorkShop 14 Charakteristika a popis systému CHM 28 LBMS 14 Leasing Logos, a. s. o. -G- 28 8,, 14 - M22 -IICZ a. s. o. IČ 41 IDM IFRS ING Management Services s. r. o. Instalační manuály 22 Interaktivní průvodce 3 INTERIS CZ, a. s. o. Internetová verze nápovědy 32 ISOLA ISVS 21 5 Mainstream Technologies, s. r. o. Manuály versus elektronické příručky 38 MARKTIME MediaWiki 14 Micros Financování Microsoft Microsoft Office SharePoint Server MIS Mobil 41 MobilChange Monitorování systému 22 MS Help 1.x 28 MS Office 14 MS SourceSafe 14 MS Virtual PC 14 MSDN 28 Multima a. s. o.

45 Index -N- -Q- Nabídka ostatních služeb 3 Nabídka služeb 21 Nabízené formáty dokumentace 27 Nabízené typy dokumentace 22 NDoc 14 NESS Czech, s. r. o. Query Selection Tool -RRaiffeisenbank a. s. o. Recomando Redakční systém BusinessInfo Reference Rejstřík 21 Research Samples RM-Systém 14 RoboHelp 14 RUP 14, 21 Ruština 14 Řidičský průkaz B 14 -OO mně 8 O oboru 5 Obchodní portál COOP Objektová analýza a návrh UML OHS OpenOffice 33 Operační systémy 14 Osvědčení o registraci S- -PPaintShop Pro 14 Patria Online, a. s. o. PDF 33, 34 Penzijní společnost České pojišťovny a. s. PlDoc 14 PLSQL Developer 14 PNC Portál stavby Portals II Postregistr.cz Prezentace 3 Principal engineering s.r.o. ProAdmin Proč vytvářet dokumentaci 5 Programový kód 22 Prométheus Provozní příručky 22 Průběh zaměstnání 14 Představení oboru SW dokumentace 5 Předzpracování Přehled zkušeností 14 PVT, a. s. o. 14 Pyxis SandCastle Help File Builder 14 SDP2 Senior SEO 14 SharePoint Designer 14 SharePoint Server SharePoint Server Siemens s. r. o. SIKS a. s. o. SIT SmartDraw 14 Smlouvy SnagIt 14 Softwarová dokumentace 5 SONY Czech, spol. s r.o. SourceSafe 14 Správa dopravních přestupků SQL 14 Subterra a. s. o. SUBTERRA Intranet Sun Virtual Box 14 SVI 2008 SVN 14 SW dokumentace 5 Šablonátor ŠKODA AUTO a. s. o. 45

46 46 Jiří Roun, Tvorba softwarové dokumentace Školení 14 Školení absolvovaná v poslední době Školící materiály T T.J. Lokomotiva Vršovice 14 Tatra banka, a. s. o. Technical Writer 5 Technická a programová dokumentace TechSmith Camtasia Studio 14 Telefon 41 Telefónica O2 Czech Republic, a. s. o. Testovací scénáře Testování aplikací 3 Tipsport a. s. o. TipV4 Tištěná dokumentace 33 Trinity Tvorba softwarové dokumentace 5 Tvorba webových stránek WW3C 21 Webové stránky 3 Wilson Wincor Nixdorf Windows 14 Windows Help 36 Word 33 -XXML 14 XML Mind XML Editor 14 -UUAT Údržba systému 22 Ukázky formátů 27 UML 14 ÚVIS 21 Uživatelská dokumentace 22 -VVedoucí Střediska služeb PVT 14 Virtual PC 14 Vista 14 VMware Workstation 14 Vodní Stavby Praha, a. s. o. 14 VoiceChange Vyhledávání 21 Vyjednávání 14 Výpis z živnostenského rejstříku 1 Vyúčtování mobilních služeb Vzdělání 14