ICS 35.080 Únor 2003
|
|
Informační technologie - |
ČSN 36 9880 |
Information technology - Guidelines for the documentation of computer-based application systems
Technologies de l'information - Principes généraux relatifs à la documentation des systèmes d'application informatisés
Informationstechnik - Leitfaden für die Dokumentation von computergestützen Anwendungssystemen
Tato norma je českou verzí mezinárodní normy ISO/IEC 6592:2000. Mezinárodní norma ISO/IEC 6592:2000 má status české technické normy.
This standard is the Czech version of the International Standard ISO/IEC 6592:2000. The International Standard ISO/IEC 6592:2000 has the status of a Czech Standard.
Nahrazení předchozích norem
Touto normou se nahrazuje ČSN ISO 6592 (36 9880) z října 1993.
|
© Český normalizační institut, 2003 66367 |
Národní předmluva
Změny proti předchozí normě
Toto vydání je ve srovnání s předchozím vydáním zcela nově pojato. Nejsou zde obsaženy směrnice pro tvorbu dokumentace v jednotlivých etapách vývoje systémů, ale kontrolní seznam pro dvě strany, který může být použit při odsouhlasování obsahu dokumentů. Tuto mezinárodní normu lze použít pro tvorbu dokumentů v jakémkoli přirozeném jazyce nebo reprezentaci. Toto vydání umožňuje vytváření dokumentů softwarového systému paralelně s životním cyklem softwaru a navazuje na nové mezinárodní normy, které byly v posledních letech vydány.
Citované normy
Nejsou citovány žádné normy. Informativní odkazy jsou uvedeny v bibliografii.
Vypracování normy
Zpracovatel: RECHEK, Praha, IČO 13155008, Ing. Jindřich Řechtáček
Technická normalizační komise: TNK 20 Informační technologie
Pracovník Českého normalizačního institutu: Ing. Petr Wallenfels
|
MEZINÁRODNÍ NORMA |
|
Informační technologie - ISO/IEC 6592 |
|
Směrnice pro tvorbu dokumentace První vydání |
|
počítačových aplikačních systémů 2000-03-15 |
ICS 35.080
|
Odmítnutí odpovědnosti za manipulaci s PDF |
|
Tento PDF soubor obsahuje vložené typy písma (normální, kurzivní, tučné atd.). V souladu s licenční politikou Adobe tento soubor lze tisknout nebo prohlížet, avšak nesmí být editován, kromě těch vložených typů písma, které nepodléhají licenci a jsou instalovány v počítači, na kterém se editace provádí. Při používání tohoto souboru jsou jeho uživatelé odpovědni za to, že nebude porušena licenční politika Adobe. Ústřední sekretariát ISO nepřejímá za její porušení žádnou odpovědnost. |
|
Adobe je obchodní značka "Adobe Systems Incorporated“. |
|
Podrobnosti o softwarovém produktu, který vytváří tento PDF soubor, lze najít ve všeobecných informacích, které jsou k němu přiloženy; parametry na vytváření PDF jsou optimalizovány pro tisk. Soubor je upraven tak, aby byl použitelný členskými organizacemi ISO. V případě nepravděpodobné události a problému, který se k ní vztahuje, informujte Ústřední sekretariát ISO. Jeho adresa je uvedena níže. |
Všechna práva vyhrazena. Žádná část této normy nesmí být reprodukována nebo zpracována jakoukoli jinou formou, jako jsou například elektronické, mechanické prostředky, včetně fotokopií a mikrofilmu bez písemného povolení ISO, povolení lze vyžádat na níže uvedené adrese nebo u členské národní organizace v zemi žadatele.
ISO copyright office
Case postale 56, CH- 1211 Geneva 20
Tel. +41 22 749 01 11
Fax. +41 22 734 10 79
e-mail copyright@iso.ch
Web www.iso.ch
Obsah
Strana
Předmluva......................................................................................................................................................................................... 5
Úvod................................................................................................................................................................................................... 6
1 Předmět normy.................................................................................................................................................................... 7
2 Normativní odkazy............................................................................................................................................................... 7
3 Termíny a definice............................................................................................................................................................... 7
4 Používání této mezinárodní normy................................................................................................................................... 8
4.1 Účel dokumentace.............................................................................................................................................................. 8
4.2 Principy tvorby dokumentace............................................................................................................................................ 8
4.3 Aplikace této mezinárodní normy na softwarový systém............................................................................................. 9
4.3.1 Aplikace všeobecně............................................................................................................................................................ 9
4.3.2 Specifikace obsahu dokumentu...................................................................................................................................... 9
4.3.3 Přezkoumání obsahu existujícího dokumentu.............................................................................................................. 9
4.4 Omezení.............................................................................................................................................................................. 10
4.5 Přizpůsobení...................................................................................................................................................................... 10
5 Metoda tvorby dokumentace............................................................................................................................................ 10
5.1 Přehled popisu informačních položek........................................................................................................................... 10
5.2 Profil dokumentace........................................................................................................................................................... 10
5.3 Popis informačních položek............................................................................................................................................ 11
Příloha A (informativní) Příklad profilu dokumentace............................................................................................................. 33
Bibliografie...................................................................................................................................................................................... 36
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ány v souladu s pravidly uvedenými v části 3 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 v této mezinárodní normě 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 6592 byla připravena společnou technickou komisí ISO/IEC JTC 1 Informační technologie, subkomisí SC 7, Softwarové inženýrství.
Toto první vydání ISO/IEC 6592 ruší a nahrazuje ISO 6592:1985, které bylo technicky revidováno.
Příloha A této mezinárodní normy je uvedena pouze pro informaci.
Úvod
Pro úspěch jakéhokoli projektu vývoje softwaru je podstatnou tvorba dokumentace. Management má určit množství a obsah dokumentů, aby se zajistilo, že jich nebude ani příliš málo, ani příliš mnoho. Nejdůležitějším faktorem je však to, aby dokumenty zahrnovaly všechny informace významné pro uživatele. Tato mezinárodní norma poskytuje metodu pro vymezení odpovídajícího souboru dokumentů, které se používají v průběhu životního cyklu projektu vývoje softwaru, včetně jejich definic a použití.
1 Předmět normy
Tato mezinárodní norma obsahuje směrnice pro tvorbu dokumentace informačních systémů (IS) a je určena pro používání v této oblasti. Tato mezinárodní norma je aplikovatelná na software v IS. Jsou zde však zahrnuty některé aspekty hardwaru, například konfigurace systému.
Tato mezinárodní norma není určena pro použití jako návod k tomu, jakým způsobem mají být dokumenty organizovány nebo strukturovány. Místo toho norma poskytuje kontrolní seznam pro dvě strany, který může být užit při odsouhlasování obsahu dokumentu.
Směrnice uvedené v této mezinárodní normě byly vytvořeny s cílem:
· získat nezbytný závazek stran zapojených do životního cyklu IS tak, aby se účastnily procesu vývoje;
· přispívat k tvorbě dobře plánovaných a normalizovaných dokumentů softwarového systému;
· umožnit tvorbu dokumentů softwarového systému paralelně s životním cyklem softwaru.
Dobře vymezená pravidla pro dokumenty během životního cyklu softwaru usnadňují:
· zajištění vhodných informací;
· přípravu vlastní dokumentace;
· odhad doby a zdrojů požadovaných pro realizaci projektu;
· výměnu informací mezi příslušnými stranami, jejímž výsledkem je:
- výběr dosažitelných cílů pro systém;
- kompletnější a dobře uvážený funkční návrh;
- méně neporozumění a chyb;
· tvorbu rozhodnutí a informování personálu v průběhu životního cyklu softwaru.
Tato mezinárodní norma je určena pro aplikaci na celý rozsah IS a předpokládá, že softwarová komponenta systému se může lišit a být nepatrnou částí systému i jeho významnou složitou komponentou.
Tato mezinárodní norma se aplikuje na dokumenty v jakémkoli přirozeném jazyce nebo reprezentaci a je nezávislá na médiu použitém pro implementaci, tj. principy jsou všeobecně aplikovatelné, ale v některých případech se mohou lišit strukturou a formátem.
Ačkoli je tato mezinárodní norma určena hlavně pro používání v oblasti softwarového inženýrství (SE), budou existovat jiné skupiny zainteresované nepřímo na SE včetně těch, kteří jsou zainteresováni na strategii SE, lidé s požadavky na SE, zákazníci SE a uživatelé SE. Pro tyto skupiny je tato mezinárodní norma také vhodná. Tyto skupiny budou vytvářet některé z dokumentů (například strategii, zákaznické požadavky a uživatelské dokumenty).
S činnostmi SE jsou spojeny metody, techniky a nástroje. Mnoho z těchto produktů má své vlastní dokumentační prostředky. Dokumenty tohoto typu mohou softwaroví inženýři použít, ale mají zajistit, aby byly dodrženy principy a postupy dané touto mezinárodní normou.
-- Vynechaný text --
Zdroj: www.cni.cz