Typer programvaredokumentasjon

Innholdsfortegnelse:

Anonim

Hvis du noen gang har sett en datakatalog på en nettverksstasjon i firmaet ditt kalt "programvaredokumenter" eller "programvareguider" og så på dokumenter du hadde tillatelse til å vise, har du sannsynligvis innsett hvor mange dokumenter og typer dokumenter for programvare er en rekke. Det ser også ut til at enkelte dokumenter som er plassert i en kategori, også gjelder for andre kategorier. Programvare dokumenter brukes i alle stadier av en typisk programvare livssyklus, så det er et godt sted å undersøke hvilken type dokumenter som er opprettet.

Forslag

Et programforslag angir programvaresystemkrav og avgrenser formålet med programvaren og problemene det løser. Det vil også spesifisere den estimerte tiden programvareprosjektet vil ta, og andre faktorer som påvirker forslaget.

Feasibility Study

Forundersøkelsen foregår vanligvis i starten av prosjektet. Dette stadiet avgjør om programvareverket tilfredsstiller kundens forretningsbehov. Resultatet av en feasibility studie avgjør om et prosjekt vil gå videre eller ikke.

Krav Analyse

En kravanalyse gir midler til å oversette forretningskrav til automatiserte programvareløsninger. En ekstern konsulent eller bedriftsledelse utfører vanligvis denne oppgaven. Kravene oversetter forretningskrav til faktiske spesifikasjoner for maskinvare, programvare og komponenter.

Design Dokumenter

Designdokumenter gir grunnlaget for programvareutvikling for å påbegynne på et teknisk nivå. Som navnet antyder, vil en rekke grafiske og tekstlige design for databaser, grensesnitt, kommunikasjon, webutvikling og andre aspekter av programvaren bli utformet før kodingen kan påbegynnes.

Kodende dokumenter

Kodingsdokumenter henviser til den faktiske kildekoden som brukes til programmering av programvare. Koden kan skrives på et hvilket som helst antall tilgjengelige dataspråk, inkludert Java, C ++, PHP og hundrevis av andre dataspråk, avhengig av hvilket system som brukes.

Testing av dokumenter

Testteam og utviklere lager testdokumenter på ulike stadier av programvarens livssyklus. Utviklere lager enhetstestingsdokumenter for sin egen kode. Testgruppen eller andre personer som ikke er direkte tilknyttet koden, foretar integreringstesting og test av bedriftskrav.

Brukerveiledninger og markedsføring

Brukerhåndbøker gir instruksjoner om hvordan den nye programvaren fungerer. Hvis systemet er stort og komplekst, blir brukerveiledninger vanligvis støttet av formelle opplæringskurs for ansatte. Markedsføringsdokumenter illustrerer fordelene med det nye programvaresystemet til potensielle kunder.

Programvarelisenser

Utstedelsen av programvarelisenser gjør at programvaren er lovlig når det gjelder sluttbrukeren. Brukere bruker programvare i henhold til en programvare lisens utstedt av forfatteren. Ikke all programvare har strenge lisensvilkår, og dette gjelder spesielt når det gjelder åpen kildekode. Generelt har programvaresystemer noen form for lisensdokument på plass som angir hvordan og hvor programvaren kan brukes.