Hvordan å gjøre et forslag dokument for Software

Programvare design dokumenter kommer i mange varianter, men nesten alle har felles mål om å beskrive programvarefunksjoner, data eller grensesnitt. Design dokumenter varierer fra høyt nivå arkitektoniske dokumenter til detaljert design dokumenter, grensesnitt styringsdokumenter og flyt dokumenter. Noen design dokumenter er fri form, mens andre følger en mer formell tilnærming slik som Unified Modeling Language (UML).

bruksanvisning

1 Bestem hvilket nivå designdokumentet vil dekke. For eksempel, hvis du gjør et grensesnitt kontrolldokument mellom programvare og et annet system eller programvarekomponent, så du trenger en lav-level design dokument som vil inneholde detaljer om grensesnittet. På den annen side, hvis du jobber med et nytt design, så du kan trenge en designdokument som en arkitektonisk utforming dokument som viser programvaren på et høyt abstraksjonsnivå.

2 Bestem hva slags informasjon som skal inkluderes. Den informasjon som skal inkluderes, vil avhenge av hvilken type design dokument du utkast og skjerpe detaljnivået du trenger. For eksempel, i et grensesnitt kontrolldokument, må du inkludere informasjon som en beskrivelse av data som skal overføres over grensesnittet, hvordan forespørsler er gjort og hvordan disse forespørslene blir besvart. Du kan også inneholde annen informasjon, for eksempel hvordan fremtidig utvidelse eller endringer vil bli håndtert og hvordan feil håndteres.

3 Utkast et dokument disposisjon. Når du vet hvilken informasjon du vil bli inkludert, kan du utarbeide en skisse av design dokument. Skissen vil fungere som din rammeverk for å skrive designdokumentet. Når du har din disposisjon ferdig, kontrollerer omrisset mot detaljnivået og informasjonen du besluttet å inkludere for å være sikker på at dokumentet vil dekke det du planla å dekke.

4 Legg designinformasjon til din disposisjon. Bruke omrisset du opprettet i forrige trinn, begynne å fylle i detaljene i designdokumentet. I grensesnittet kontrolldokument eksempel kan du identifisere ting som de spesifikke dataelementer som utveksles i en bestemt datastruktur eller tidspunktet for datautveksling. Du bør skrive din design dokument til et detaljnivå som helt formidler nødvendig informasjon for å forstå utformingen på riktig nivå.

5 Oppdater designdokumentet som ting endres. Software design vanligvis utvikle seg som et prosjekt utvikler seg. Sørg for å se ditt design dokument og holde den up-to-date med den nåværende utformingen slik at når prosjektet er fullført, design dokumentet nøyaktig gjenspeiler den ferdige design og kan brukes av andre i fremtiden for vedlikehold eller modifisering oppgaver.

Hint

• Når utforme en software design dokument huske formålet med dokumentet og hvordan den skal brukes.
• Når du er ferdig med design dokument, gjør en "sunn fornuft sjekk" av objektivt å vurdere om en person er kjent med programvaren vil være i stand til å forstå den nødvendige informasjonen bare fra å lese din design dokument.