Typer af software dokumentation

Indholdsfortegnelse:

Anonim

Hvis du nogensinde har set en datakatalog på et netværksdrev i dit firma, der hedder "softwaredokumenter" eller "softwareguides", og så på dokumenter, du havde tilladelse til at se, har du sikkert indset, at antallet af dokumenter og typer af dokumenter til software er talrige. Det ser også ud til, at nogle dokumenter i en kategori også gælder for andre kategorier. Software-dokumenter bruges i alle faser af en typisk software livscyklus, så det er et godt sted at undersøge typen af ​​dokumenter, der oprettes.

Forslag

Et software-forslag specificerer software systemkrav og afgrænser formålet med softwaren og de problemer, det løser. Det vil også angive den estimerede tid, softwareprogrammet vil tage, og andre faktorer, der påvirker forslaget.

Forundersøgelse

Forundersøgelsen finder normalt sted i starten af ​​projektet. Denne fase afgør, om softwareanlægget opfylder kundens forretningsbehov. Resultatet af en gennemførlighedsundersøgelse afgør, om et projekt vil gå videre eller ej.

Krav Analyse

En kravanalyse giver mulighed for at oversætte forretningskrav til automatiserede software løsninger. En ekstern konsulent eller virksomhedsledelse udfører normalt denne opgave. Kravene oversætter virksomhedskrav til faktiske specifikationer for hardware, software og komponenter.

Design Dokumenter

Designdokumenterne udgør grundlaget for softwareudvikling til at starte på et teknisk niveau. Som navnet antyder, vil en række grafiske og tekstlige designs til databaser, grænseflader, kommunikation, webudviklinger og andre aspekter af softwaren blive designet, før kodning kan begynde.

Kodningsdokumenter

Kodningsdokumenter henviser til den faktiske kildekode, der bruges til programmering af software. Koden kan skrives på et hvilket som helst antal tilgængelige computersprog, herunder Java, C ++, PHP og hundredvis af andre computersprog afhængigt af det anvendte system.

Testning af dokumenter

Testhold og udviklere opretter testdokumenter på forskellige stadier af softwarens livscyklus. Udviklere opretter enhedstestdokumenter for deres egen kode. Testgruppen eller andre personer, der ikke er direkte tilknyttet koden, foretager integrationstest og test af virksomhedskrav.

Brugervejledning og marketing

Brugervejledninger giver vejledning om, hvordan den nye software fungerer. Hvis systemet er stort og komplekst, er brugervejledninger normalt sikkerhedskopieret af formelle kurser for personale. Markedsdokumenter illustrerer fordelene ved det nye software system til potentielle kunder.

Software Licenser

Udstedelsen af ​​softwarelicenser gør softwaren lovlig for så vidt angår slutbrugeren. Brugere bruger software i henhold til en software licens udstedt af forfatteren. Ikke alle software har strenge licensvilkår, og det gælder især open source. Generelt har software-systemer en form for licens-dokument på plads, der angiver, hvor og hvor softwaren kan bruges.