Zdroj: www.cni.cz

ČESKÁ NORMA

MDT 681.3.06

Květen 1994

Informační technika
SMĚRNICE PRO ŘÍZENÍ TVORBY
DOKUMENTACE SOFTWARU

ČSN
ISO/IEC TR 9294

36 9807

 

 

 

Information technology - Guidelines for the management of software documentation

Technologies de ľinformation - Lignes directrices pour la gestion de la documentation technique du logiciel

Informatik - Die Richtlinien für Die Steuerung der Softwardokumentation

 

Tato norma obsahuje ISO/IEC TR 9294:1990

 

Národní předmluva

Základní normou ISO v oblasti dokumentace softwaru je norma ISO 6592, která je v současné době v technické komisi ISO revidována. Z tohoto důvodu není zavedena do ČSN.

Technická zpráva ISO/IEC TR 9294 obsahuje základní principy, kterými se má řídit vedení organizace produkující software a přidruženou dokumentaci. Proto je zpráva do ČSN zaváděna.

 

Citované normy

ISO 2382 dosud nezavedena

ISO 6592 dosud nezavedena

ISO 9127 zavedena v ČSN ISO 9127 Systémy zpracování informací, Uživatelská dokumentace a informace na obalu zákaznických softwarových balíků

 

Vypracování normy

Zpracovatel: RECHEK, Praha, IČO 13155008, Ing. Jindřich Řechtáček

Technická normalizační komise: TNK 20 Informační technika

Pracovník Českého normalizačního institutu: Ing. Petr Wallenfels

 

Ó Český normalizační institut, 1994




16215


Strana 2

INFORMAČNÍ TECHNIKA -

ISO/IEC TR 9294

SMĚRNICE PRO ŘÍZENÍ TVORBY

První vydání

DOKUMENTACE SOFTWARU

1990-11-15


 

Obsah

 

strana

 

 

 

Předmluva

2

Úvod

3

1

Předmět normy

3

2

Odkazy na normy

3

3

Definice

3

4

Úloha manažerů

4

5

Funkce dokumentace softwaru

4

5.1

Komunikace s vedením

4

5.2

Komunikace mezi úlohami

4

5.3

Zabezpečení jakosti

5

5.4

Instrukce a odkazy

5

5.5

Podpora softwaru

5

5.6

Historická reference

5

6

Stanovení koncepce tvorby dokumentace

5

7

Stanovení dokumentačních norem a směrnic

6

7.1

Výběr modelu životního cyklu softwaru

6

7.2

Definování typů dokumentů a jejich obsahu

7

7.3

Definování jakosti dokumentů

8

7.4

Definování formátů dokumentů

8

7.5

Definování systému identifikace dokumentů

9

8

Stanovení postupů pro tvorbu dokumentace

9

9

Přidělení zdrojů na tvorbu dokumentace

9

9.1

Lidé

9

9.2

Prostředky

10

9.3

Fondy

10

10

Plánování tvorby dokumentace

10

Příloha A

Kontrolní seznam pro řízení tvorby dokumentace softwaru

A.1 Kontrolní seznam koncepce

11

A.2 Kontrolní seznam norem

11

A.3 Kontrolní seznam postupů

11

A.4 Kontrolní seznam pro plánování projektu

11

 

Předmluva

 

ISO (Mezinárodní organizace pro normalizaci) a IEC (Mezinárodní elektrotechnická komise) vytvářejí systém celosvětové normalizace jako celek. Národní orgány, které jsou členy ISO nebo IEC, se účastní práce prostřednictvím technických komisí založených každou organizací k projednávání jednotlivých oborů technické činnosti. Technické komise ISO a IEC spolupracují v oborech oboustranného zájmu. Jiné mezinárodní organizace - vládní  i nevládní - se také ve spolupráci s ISO a IEC práce účastní.

V oboru informační techniky byla v rámci ISO a IEC založena společná technická komise - ISO/IEC JTC 1.

Hlavním úkolem technické komise je připravovat mezinárodní normy, ve zvláštních případech však může být navrženo vydání jednoho z následujících typů technických zpráv:

- typ 1 - pokud nemůže být v technické komisi získána potřebná podpora pro vydání mezinárodní normy navzdory opakovanému úsilí,

- typ 2 - pokud je předmět zájmu stále v technickém vývoji, který vyžaduje další připomínkování,

- typ 3 - pokud technická komise shromáždí údaje rozdílné od těch, které jsou normálně vydány jako mezinárodní norma (např. „dosažená úroveň poznání").


Strana 3

Technické zprávy typu 1 a typu 2 podléhají během dalších tří let od vydání posouzení a rozhodnutí, zda budou zpracovány do mezinárodní normy. Technickou zprávu typu 3 není nutné posuzovat až do doby, kdy poskytované údaje dále pozbudou platnosti nebo užitečnosti.

ISO/IEC TR 9294, což je technická zpráva typu 3, byla připravena technickou komisí ISO/IEC JTC 1 - Informační technika.

 

Úvod

 

Dokumentace je vyžadována ve všech stádiích životního cyklu softwaru. Pro přípravu a údržbu dokumentace je nezbytné vynaložit nepřetržité úsilí od počátku vývoje softwaru až po jeho dokončení. Tvorba dokumentace začíná při zahájení projektu a pokračuje během návrhu, vývoje, testování, instalace, používání, modifikace a doplňování softwaru. Proces tvorby dokumentace lze ukončit až na konci životního cyklu softwaru.

Dokumentace je základem úspěchu každého projektu vývoje softwaru a tvorba dokumentace vyžaduje čas, úsilí i peníze. Vedení organizace je odpovědné za zabezpečení efektivního využití těchto zdrojů na základě uznání důležitosti dokumentace pro jakost a úspěch softwarového produktu.

 

1 Předmět normy

 

Tato norma nabízí návod pro řízení tvorby dokumentace softwaru pro manažery, kteří jsou odpovědni za tvorbu softwaru a produktů založených na softwaru. Tyto směrnice jsou určeny jako pomoc manažerům při zajišťování tvorby efektivní dokumentace v jejich organizaci.

Tato norma se věnuje koncepcím, normám, postupům, zdrojům a plánům, kterými se musí manažeři zabývat, aby efektivně řídili zpracování dokumentace softwaru.

Směrnice jsou určeny k použití pro všechny typy softwaru, od nejjednoduššího programu až po nejsložitější softwarový soubor nebo softwarový systém. Pokrývají všechny typy dokumentace ve všech stádiích životního cyklu softwaru.

Zásady řízení tvorby dokumentace softwaru jsou stejné bez ohledu na velikost projektu. Pro malé projekty nemusí být mnohé podrobnosti uvedené v této normě použity, ale zásady zůstávají shodné. Manažeři mohou přizpůsobit doporučení svým konkrétním potřebám.

Mělo by být zdůrazněno, že pravidla jsou stanovena z pohledu řízení tvorby dokumentace.Podrobné rady, např. k obsahu a formě softwarových dokumentů nejsou uvedeny.

 



-- Vynechaný text --

Zdroj: www.cni.cz