Tipuri de documentație software

Cuprins:

Anonim

Dacă ați văzut vreodată un director de computer pe o unitate de rețea din compania dvs. numită "documente software" sau "ghiduri de software" și apoi ați examinat documentele pe care ați avut permisiunea de a le vizualiza, probabil că ați constatat numărul de documente și tipuri de documente pentru software numeroase. De asemenea, s-ar părea că unele documente plasate într-o categorie se aplică și altor categorii. Documentele software sunt utilizate în fiecare etapă a unui ciclu de viață tipic al software-ului, astfel că este un loc bun pentru a investiga tipul de documente create.

Propunere

O propunere de software specifică cerințele de sistem software și definește scopul software-ului și problemele pe care le rezolvă. De asemenea, va specifica durata estimată a proiectului software și alți factori care afectează propunerea.

Studiu de fezabilitate

Studiul de fezabilitate are loc de obicei la începutul proiectului. Această etapă determină dacă instalația software satisface nevoile de afaceri ale clientului. Rezultatul unui studiu de fezabilitate decide dacă un proiect va merge mai departe sau nu.

Analiza cerințelor

Analiza cerințelor oferă mijloacele de a traduce cerințele afacerii în soluții software automatizate. Un consultant extern sau un management al companiei efectuează de obicei această sarcină. Cerințele tratează cerințele afacerii în specificații reale pentru hardware, software și componente.

Documente de proiectare

Documentele de proiectare oferă baza pentru dezvoltarea software-ului pentru a începe la nivel tehnic. După cum sugerează și numele, un număr de modele grafice și textuale pentru baze de date, interfețe, comunicații, dezvoltări web și alte aspecte ale software-ului vor fi proiectate înainte de începerea codării.

Codificarea documentelor

Codificarea documentelor se referă la codul sursă efectiv folosit pentru programarea software-ului. Codul poate fi scris în orice număr de limbi de calcul disponibile, inclusiv Java, C ++, PHP și sute de alte limbi de calculator, în funcție de sistemul utilizat.

Testarea documentelor

Echipele de testare și dezvoltatorii creează documente de testare în diferite stadii ale ciclului de viață al software-ului. Dezvoltatorii creează documente de testare a unității pentru propriul cod. Echipa de testare sau alte persoane care nu sunt direct asociate cu codul efectuează teste de integrare și testare a cerințelor afacerii.

Ghiduri de utilizare și marketing

Ghidurile de utilizare oferă instrucțiuni privind modul în care funcționează noul software. Dacă sistemul este mare și complex, ghidurile de utilizare sunt, de obicei, susținute de cursuri formale de formare pentru personal. Documentele de marketing ilustrează beneficiile noului sistem software pentru clienții potențiali.

Licențe de software

Emiterea de licențe software face utilizarea software legală în ceea ce privește utilizatorul final. Utilizatorii folosesc software în condițiile unei licențe de software emise de compania de creație. Nu toate programele software au termeni stricți de licențiere și acest lucru este valabil în special în cazul sursei deschise. În general, sistemele software au o anumită formă de document de licențiere specificând modul și locul în care poate fi folosit software-ul.