Typy softvérovej dokumentácie

Obsah:

Anonim

Ak ste niekedy videli počítačový adresár na sieťovej jednotke vo vašej spoločnosti s názvom "softvérové ​​dokumenty" alebo "sprievodcovia softvéru" a potom sa pozrel na dokumenty, ktoré máte povolenie na zobrazenie, pravdepodobne ste si uvedomili, že počet dokumentov a typov dokumentov pre softvér je početné. Zdá sa tiež, že niektoré dokumenty zaradené do jednej kategórie sa vzťahujú aj na iné kategórie. Softvérové ​​dokumenty sa používajú v každej fáze typického životného cyklu softvéru, takže je vhodným miestom na vyšetrenie typu vytvorených dokumentov.

návrh

Návrh softvéru špecifikuje požiadavky na softvérové ​​systémy a vymedzuje účel softvéru a problémy, ktoré rieši. Taktiež určuje odhadovaný čas, ktorý projekt softvéru prijme, a ďalšie faktory ovplyvňujúce návrh.

Štúdie uskutočniteľnosti

Štúdia uskutočniteľnosti sa zvyčajne uskutočňuje na začiatku projektu. Táto fáza určuje, či softvérová jednotka spĺňa obchodné potreby zákazníka. Výsledok štúdie uskutočniteľnosti rozhodne, či projekt bude pokračovať, alebo nie.

Analýza požiadaviek

Analýza požiadaviek poskytuje prostriedky na preklad podnikových požiadaviek do automatizovaných softvérových riešení. Na túto úlohu obvykle vykonáva externý konzultant alebo vedenie spoločnosti. Požiadavky prekladajú obchodné požiadavky do skutočných špecifikácií pre hardvér, softvér a komponenty.

Konštrukčné dokumenty

Konštrukčné dokumenty poskytujú základ pre vývoj softvéru na technickej úrovni. Ako to naznačuje názov, pred začatím kódovania bude navrhnutých niekoľko grafických a textových návrhov pre databázy, rozhrania, komunikácie, vývoj webu a ďalšie aspekty softvéru.

Kódovacie dokumenty

Kódovacie dokumenty sa vzťahujú na skutočný zdrojový kód použitý na programovanie softvéru. Kód môže byť napísaný v ľubovoľnom počte dostupných počítačových jazykov vrátane Java, C ++, PHP a stoviek ďalších počítačových jazykov v závislosti od použitého systému.

Testovanie dokumentov

Testovacie tímy a vývojári vytvárajú testovacie dokumenty v rôznych fázach životného cyklu softvéru. Vývojári vytvárajú dokumenty na testovanie jednotiek pre svoj vlastný kód. Testovací tím alebo iní ľudia, ktorí priamo nesúvisia s kódom, absolvujú testovanie integrácie a testovanie obchodných požiadaviek.

Používateľské príručky a marketing

Používateľské príručky poskytujú pokyny o tom, ako nový softvér funguje. Ak je systém veľký a zložitý, používateľské príručky sú zvyčajne podporované formálnymi školeniami pre zamestnancov. Marketingové dokumenty ilustrujú prínosy nového softvérového systému pre potenciálnych zákazníkov.

Softvérové ​​licencie

Vydanie softvérových licencií spôsobuje, že softvér je legálny, pokiaľ ide o koncového užívateľa. Používatelia používajú softvér podľa podmienok softvérovej licencie, ktorú vydala autorská spoločnosť. Nie všetky softvéry majú prísne licenčné podmienky, a to platí najmä pre open source. Softvérové ​​systémy majú vo všeobecnosti nejaký druh licenčného dokumentu, v ktorom sa uvádza, ako a kde sa môže softvér používať.