ICS 35.080 Duben 2002
|
|
Informační technologie - Proces |
ČSN 36 9039 |
Information technology - Software user documentation process
Technologies de l’information - Procédé de documentation d’utilisateur de logiciel
Informationstechnik - Prozeßmodell für die Erstellung einer Software- Benutzerdokumentation
Tato norma je českou verzí mezinárodní normy ISO/IEC 15910:1999. Mezinárodní norma ISO/IEC 15910:1999 má status české technické normy.
This standard is the Czech version of the International Standard ISO/IEC 15910:1999. The International Standard ISO/IEC 15910:1999 has the status of a Czech Standard.
|
© Český normalizační institut, 2002 63882 |
Národní předmluva
Citované normy
ISO 216:1975 zavedena v ČSN EN 20216:1993 (50 0042) Psací papír a některé druhy tiskovin. Rozměry - řady A a B
Upozornění na národní přílohu
Do této normy byla doplněna národní příloha NA (informativní), která obsahuje vysvětlivky k textu převzaté normy.
Vypracování normy
Zpracovatel: RECHEK, Praha, IČO 13155008, Ing. Jindřich Řechtáček
Technická normalizační komise: TNK 42 Výměna dat
Pracovník Českého normalizačního institutu: Ing. Petr Wallenfels
|
MEZINÁRODNÍ NORMA |
|
Informační technologie - ISO/IEC 15910 |
|
Proces uživatelské dokumentace softwaru První vydání |
|
1999-12-15 |
ICS 35.080
Obsah
Strana
Předmluva......................................................................................................................................................................................... 5
Úvod................................................................................................................................................................................................... 6
1 Předmět normy.................................................................................................................................................................... 7
2 Shoda.................................................................................................................................................................................... 7
3 Normativní odkazy............................................................................................................................................................... 7
4 Termíny a definice............................................................................................................................................................... 7
5 Management kvality........................................................................................................................................................... 10
6 Přizpůsobování.................................................................................................................................................................. 11
7 Cíle....................................................................................................................................................................................... 11
8 Požadavky........................................................................................................................................................................... 11
8.1 Proces dokumentace........................................................................................................................................................... 11
8.1.1 Všeobecně.......................................................................................................................................................................... 11
8.1.2 Opatření zdrojového materiálu........................................................................................................................................ 11
8.1.3 Plán dokumentace................................................................................................................................................................ 13
8.1.4 Přezkoumání...................................................................................................................................................................... 14
8.1.5 Testování použitelnosti dokumentace........................................................................................................................... 16
8.1.6 Vývoj dokumentace jako smluvní subdodávka jiným společnostem...................................................................... 17
8.1.7 Změnové řízení a údržba dokumentu............................................................................................................................ 17
8.2 Obsah specifikace stylu................................................................................................................................................... 18
8.2.1 Všeobecně.......................................................................................................................................................................... 18
8.2.2 Styl psaní............................................................................................................................................................................. 18
8.2.3 Papírová dokumentace.................................................................................................................................................... 18
8.2.4 Elektronická dokumentace.............................................................................................................................................. 23
Příloha A (informativní) Křížové odkazy na ISO/IEC 12207.................................................................................................... 26
Příloha B (informativní) Odkazy na tuto mezinárodní normu ve smlouvě............................................................................ 27
Příloha C (informativní) Vzorový plán dokumentace: uživatelská dokumentace pro systém managementu
pásek ABC..................................................................................................................................................................... 28
Příloha D (informativní) Vzájemné vztahy mezi cílovou skupinou, úlohami, papírovou a on-line dokumentací........... 32
Příloha E (informativní) Psaní v angličtině pro překlad........................................................................................................... 35
Příloha F (informativní) Odhadování........................................................................................................................................... 38
Příloha G (informativní) Posuzování plánu dokumentace.......................................................................................................... 41
Příloha H (informativní) Vzorová specifikace stylu................................................................................................................... 42
Strana
Bibliografie...................................................................................................................................................................................... 47
Rejstřík............................................................................................................................................................................................. 48
Národní příloha NA (informativní)............................................................................................................................................... 52
NA.1 Vysvětlivky k textu převzaté normy...................................................................................................................................... 52
Předmluva
ISO (Mezinárodní organizace pro normalizaci) a IEC (Mezinárodní elektrotechnická komise) tvoří specializovaný systém celosvětové normalizace. Národní orgány, které jsou členy ISO nebo IEC, se podílejí na vypracování mezinárodních norem prostřednictvím technických komisí zřízených příslušnou organizací, aby se zabývaly určitou oblastí technické činnosti. V oblastech společného zájmu technické komise ISO a IEC spolupracují. Práce se zúčastňují i jiné mezinárodní organizace, vládní i nevládní, s nimiž ISO a IEC navázaly pracovní styk.
Návrhy mezinárodních norem jsou zpracovávány v souladu s pravidly uvedenými ve 3. části Směrnic ISO/IEC.
V oblasti informační technologie zřídily ISO a IEC společnou technickou komisi ISO/IEC JTC 1. Návrhy mezinárodních norem přijaté společnou technickou komisí se rozesílají národním orgánům k hlasování. Vydání mezinárodní normy vyžaduje souhlas alespoň 75 % hlasujících členů.
Pozornost je třeba věnovat možnosti, že některé prvky této mezinárodní normy mohou být předmětem patentových práv. ISO a IEC nenesou odpovědnost za identifikaci všech patentových práv nebo kteréhokoliv z nich.
Mezinárodní norma ISO/IEC 15910 byla připravena společnou technickou komisí ISO/IEC JTC 1 Informační technologie, subkomisí SC 7, Softwarové inženýrství.
Přílohy A až H této mezinárodní normy jsou uvedeny pouze pro informaci.
Úvod
Existují dva základní typy norem:
a) normy pro produkty, které specifikují charakteristiky a funkční požadavky na produkty,
b) normy pro procesy, které specifikují způsob, jakým mají být produkty vyvíjeny.
Neustále se zvyšující rozsah aplikací a složitost počítačového softwaru činí nezbytnou dostupnost úplné, přesné a pochopitelné dokumentace pro ty, kteří software používají. Tato mezinárodní norma poskytuje nástroj pro dosažení tohoto cíle specifikováním těch činností (co má být uděláno a kdo to má udělat), které mohou ovlivnit kavalitu uživatelské dokumentace softwaru.
Na dokumentaci se často hledí jako na něco, co je možno vytvořit po implementaci softwaru. Pro kvalitní tvorbu softwarové dokumentace se však má na ni hledět jako na nedílnou součást procesu tvorby softwaru. Pokud je dělána řádně, jde o dost velkou práci, která vyžaduje vlastní proces plánování. Záměrem této mezinárodní normy je vyzvat projektanty softwaru, aby dali procesu dokumentace jeho správné místo. Tato mezinárodní norma také dává uživatelům a klientům nástroj pro zajištění toho, že tento proces byl uskutečněn.
Hlavní činností této mezinárodní normy je vytvořit vyčerpávající plán pro vývoj dokumentace. Plán je nezbytný, protože to, že výsledků bude dosaženo, je pravděpodobnější, pokud jsou výsledky plánovány. Aby byl plán v souladu s touto mezinárodní normou, musí obsahovat specifikaci stylu. Tato mezinárodní norma nespecifikuje obsah této specifikace stylu (tj. nespecifikuje konkrétní rozvržení nebo druh písma), ale specifikuje to, co musí specifikace pokrývat. Tato mezinárodní norma také specifikuje, jaké druhy informací má akvizitér učinit dostupnými dokumentátorovi a kdo má přezkoumat a reprodukovat dokumentaci.
Další informace týkající se tohoto tématu mohou být získány kontaktováním příslušných organizací nebo z literatury (viz bibliografie).
Tato mezinárodní norma byla připravena v ISO/IEC JTC 1 SC 7 a je založena na australské normě AS 4258:1994. Mapování této mezinárodní normy na ISO/IEC 12207:1995 je uvedeno v příloze A.
1 Předmět normy
Tato mezinárodní norma specifikuje minimální proces vytvoření všech forem uživatelské dokumentace pro software s uživatelským rozhraním. Tyto formy dokumentace zahrnují tištěnou dokumentaci (například příručky uživatele a referenční karty), on-line dokumentaci, texty nápovědy a systémy on-line dokumentace.
Tato mezinárodní norma je ve shodě s ISO/IEC 12207:1995 Informační technologie - Procesy v životním cyklu softwaru, jako implementace uživatelské dokumentace podle části 6.1: Dokumentace.
Pokud je tato mezinárodní norma efektivně aplikována, podpoří vývoj dokumentace, která uspokojuje potřeby uživatelů.
Tato mezinárodní norma je určena pro každého, kdo vytváří nebo kupuje uživatelskou dokumentaci.
Tato mezinárodní norma je aplikovatelná nejen na tištěnou dokumentaci, ale také na obrazovky nápovědy, systém předávání nápovědy, na on-line text a systém předávání. Viz bibliografii.
Tato mezinárodní norma je určena pro používání při dvoustranných vztazích a rovněž může být aplikována tam, kde jsou dvě strany ze stejné organizace. Může pokrývat situace od neformálních dohod až po právně závaznou smlouvu. Tato mezinárodní norma může být použita i jednou stranou při dobrovolných úlohách.
POZNÁMKA Další návod pro použití této mezinárodní normy ve smlouvě mezi akvizitérem a dokumentátorem je uveden v příloze B.
-- Vynechaný text --
Zdroj: www.cni.cz