Druhy softwarové dokumentace

Obsah:

Anonim

Pokud jste někdy viděli adresář počítače na síťové jednotce ve vaší společnosti s názvem "softwarové dokumenty" nebo "průvodce softwaru" a pak jste se podívali na dokumenty, které máte oprávnění k zobrazení, pravděpodobně jste si uvědomili, že počet dokumentů a typů dokumentů pro software je početné. Zdá se také, že některé dokumenty zařazené do jedné kategorie se vztahují i ​​na jiné kategorie. Softwarové dokumenty se používají v každé fázi běžného životního cyklu softwaru, takže je vhodným místem pro zkoumání typu vytvořených dokumentů.

Návrh

Návrh softwaru specifikuje požadavky na softwarový systém a vymezuje účel softwaru a problémy, které řeší. Bude také specifikovat odhadovaný čas, který projekt softwaru učiní, a další faktory ovlivňující návrh.

Studie proveditelnosti

Studie proveditelnosti se obvykle odehrává na začátku projektu. Tato fáze určuje, zda softwarová zařízení splňuje obchodní potřeby zákazníka. Výsledek studie proveditelnosti rozhodne, zda projekt bude pokračovat nebo ne.

Analýza požadavků

Analýza požadavků poskytuje prostředky k překladu podnikových požadavků do automatizovaných softwarových řešení. Na tento úkol obvykle vykonává externí konzultant nebo vedení společnosti. Požadavky překládají podnikové požadavky do aktuálních specifikací pro hardware, software a komponenty.

Design Documents

Návrhové dokumenty poskytují základ pro vývoj softwaru na technické úrovni. Jak napovídá název, bude před zahájením kódování navrženo množství grafických a textových návrhů pro databáze, rozhraní, komunikace, vývoj webu a další aspekty softwaru.

Kódování dokumentů

Kódování dokumentů se týká skutečného zdrojového kódu použitého pro programování softwaru. Kód může být napsán v libovolném počtu dostupných počítačových jazyků, včetně Java, C ++, PHP a stovek dalších počítačových jazyků v závislosti na použitém systému.

Testování dokumentů

Testovací týmy a vývojáři vytvářejí testovací dokumenty v různých fázích životního cyklu softwaru. Vývojáři vytvářejí dokumenty o testování jednotky pro vlastní kód. Testovací tým nebo jiné osoby, které přímo nesouvisí s kódem, provádějí testování integrace a testování požadavků na podnikání.

Uživatelské příručky a marketing

Uživatelské příručky poskytují pokyny, jak funguje nový software. Pokud je systém velký a složitý, uživatelské příručky jsou zpravidla podporovány formálními školeními pro zaměstnance. Marketingové dokumenty ilustrují přínosy nového softwarového systému pro potenciální zákazníky.

Licence na software

Vydávání softwarových licencí způsobuje, že software je legální, pokud jde o koncového uživatele. Uživatelé používají software podle podmínek softwarové licence vydané autorskou společností. Ne každý software má striktní licenční podmínky, a to platí zejména v případě open source. Obecně platí, že softwarové systémy mají nějakou formu licenčního dokumentu, který určuje, jak a kde může být software použit.