Tipus de documentació de programari

Taula de continguts:

Anonim

Si alguna vegada heu vist un directori d'ordinador en una unitat de xarxa de la vostra empresa anomenada "documents de programari" o "guies de programari" i, a continuació, consulteu els documents que tenia permís per veure, probablement es va adonar que la quantitat de documents i tipus de documents per al programari són nombrosos. També sembla que alguns documents ubicats en una categoria també s'apliquen a altres categories. Els documents de programari s'utilitzen en totes les etapes d'un cicle de vida típic del programari, de manera que és un bon lloc per investigar el tipus de documents creats.

Proposta

Una proposta de programari especifica els requisits del sistema de programari i defineix el propòsit del programari i els problemes que resol. També s'especifica el temps estimat del projecte de programari i altres factors que afecten la proposta.

Estudi de viabilitat

L'estudi de viabilitat sol tenir lloc al principi del projecte. Aquesta etapa determina si la instal·lació del programari satisfà les necessitats empresarials del client. El resultat d'un estudi de viabilitat decideix si un projecte seguirà o no.

Anàlisi de requisits

Una anàlisi de requisits proporciona els mitjans per traduir requisits empresarials a solucions de programari automatitzades. Un assessor extern o gestió d'empreses normalment realitza aquesta tasca. Els requisits tradueixen requisits empresarials a especificacions reals de maquinari, programari i components.

Documents de disseny

Els documents de disseny proporcionen la base per al desenvolupament de programari a partir d'un nivell tècnic. Com el seu nom indica, es dissenyaran una sèrie de dissenys gràfics i textuals per a bases de dades, interfícies, comunicacions, desenvolupaments web i altres aspectes del programari abans de començar la codificació.

Codificació de documents

Els documents de codificació es refereixen al codi font real utilitzat per a la programació del programari. El codi es pot escriure en qualsevol nombre d'idiomes informàtics disponibles, incloent Java, C ++, PHP i centenars d'altres llenguatges informàtics segons el sistema utilitzat.

Prova de documents

Els equips de prova i els desenvolupadors creen documents de prova en diverses etapes del cicle de vida del programari. Els desenvolupadors creen documents de prova d'unitats per al seu propi codi. L'equip de proves o altres persones no directament associades amb el codi realitzen proves d'integració i proves de requisits empresarials.

Guies d'usuari i màrqueting

Les guies dels usuaris proporcionen instruccions sobre com funciona el nou programari. Si el sistema és gran i complex, les guies d'usuari solen tenir una còpia de seguretat dels cursos formatius formals per al personal. Els documents de màrqueting il·lustren els beneficis del nou sistema de programari a clients potencials.

Llicències de programari

L'emissió de llicències de programari fa que el programari sigui legal pel que fa a l'usuari final. Els usuaris utilitzen programari sota els termes d'una llicència de programari emesa per l'empresa autònoma. No tot el programari té termes de llicència estrictes, i això és particularment cert en el cas del codi obert. En general, els sistemes de programari tenen alguna forma de document de llicència que especifica com i on es pot utilitzar el programari.