Typer av programdokumentation

Innehållsförteckning:

Anonim

Om du någonsin har sett en datakatalog på en nätverksenhet i ditt företag med namnet "programdokument" eller "programguider" och sedan tittat på dokument som du hade tillstånd att visa visade du förmodligen hur många dokument och typer av dokument för programvara är talrik. Det förefaller också att vissa dokument som placeras i en kategori gäller också för andra kategorier. Programdokument används i alla skeden av en typisk livscykel för mjukvaran, så det är ett bra ställe att undersöka vilken typ av dokument som skapas.

Förslag

Ett mjukvaruprojekt anger systemets systemkrav och avgränsar syftet med mjukvaran och problemen som den löser. Det kommer även att ange den beräknade tid som mjukvaruprojektet ska ta och andra faktorer som påverkar förslaget.

Genomförbarhetsstudie

Förundersökningen sker vanligen vid projektets början. Detta stadium avgör om mjukvaruanläggningen uppfyller kundens affärsbehov. Resultatet av en genomförbarhetsstudie avgör om ett projekt ska gå vidare eller inte.

Kravanalys

En kravanalys ger möjlighet att översätta affärskrav till automatiserade mjukvarulösningar. En extern konsult eller företagsledning utför vanligtvis denna uppgift. Kraven översätter företagskrav till faktiska specifikationer för hårdvara, programvara och komponenter.

Designdokument

Designdokument utgör grunden för mjukvaruutveckling för att påbörja på en teknisk nivå. Som namnet antyder kommer ett antal grafiska och textliga mönster för databaser, gränssnitt, kommunikation, webbutvecklingar och andra aspekter av mjukvaran att utformas innan kodning kan påbörjas.

Kodande dokument

Kodningsdokument hänvisar till den faktiska källkoden som används för programmering av programvara. Koden kan skrivas på ett antal tillgängliga datorspråk, inklusive Java, C ++, PHP och hundratals andra datorspråk beroende på vilket system som används.

Testa dokument

Testteam och utvecklare skapar testdokument i olika skeden av programvarans livscykel. Utvecklare skapar enhetsprovningsdokument för sin egen kod. Testgruppen eller andra personer som inte är direkt associerade med koden, utför integritetstestning och test av företagskrav.

Användarhandböcker och marknadsföring

Användarhandböckerna innehåller instruktioner om hur den nya programvaran fungerar. Om systemet är stort och komplext, stöds användarhandböcker normalt av formella kurser för personal. Marknadsdokument illustrerar fördelarna med det nya mjukvarusystemet till potentiella kunder.

Programvarulicenser

Utgivning av programvarulicenser gör att mjukvaran används lagligt vad gäller slutanvändaren. Användare använder programvara enligt villkoren för en programlicens som utfärdats av upphovsföretaget. Inte all programvara har strikta licensvillkor, och det är särskilt sant vid öppen källkod. Generellt har mjukvarusystem någon form av licensdokument på plats som anger hur och var programvaran kan användas.