Hoe kan ik een software design document schrijven

December 5


Hoe kan ik een software design document schrijven

Een software design document is het "hoe" van de software life-cycle documentatie. Het beschrijft hoe de software-eisen moeten worden toegepast en het geeft de programmeurs een blauwdruk te volgen. De software design document is een schriftelijke overeenkomst tussen u, uw team, uw project manager en uw klant. Wanneer u documenteren je aannames, beslissingen en risico's, het geeft de teamleden en belanghebbenden de gelegenheid om het eens of om te vragen om verduidelijkingen en wijzigingen. Zodra de software design document is goedgekeurd door de juiste partijen, wordt een basislijn voor veranderingen in de omvang van het project te beperken.

Instructies

•  Onderzoek het document opmaak / template gebruikt in de software requirements document. Dit omvat titelpagina, paginanummering formaat, sectie nummers en revisiegeschiedenis. Met dezelfde of soortgelijke document format voor het softwareontwerp document.

•  Neem wat, zo niet alle, van de volgende elementen: - Hoog niveau samenvatting - Definities van een niet-standaard symbolen, vormen, acroniemen en unieke termen in het document - Hoe elke eis zal worden bereikt - Veronderstellingen - Beperkingen - Software risico analyse - procedures Ontwikkeling en codering richtlijnen - Standaard talen en gereedschappen - definities van variabelen en een beschrijving van waar ze worden gebruikt - Logische structuur en logische stappen verwerking - Fout, alarm en waarschuwingsberichten - Beveiligingsmaatregelen - Performance - Betrouwbaarheid

•  Bedenk hoe het ontwerp document te structureren. Dit is vooral belangrijk als je het ontwerpen van een groot, complex systeem. Breek het systeem in logische delen en gebruik deze onderdelen als de sectie headers in de software design document. Als het systeem is erg groot, maken meerdere ontwerp documenten, elk een over een bepaald deel van het systeem.

•  Geef elk design element een unieke identificatie. Hierdoor kan het terug naar de toepasselijke vereiste en uiteindelijk de toepasselijke tests worden getraceerd.

•  Include genoeg detail voor de programmeurs, terwijl de integratie van een aantal samenvattingen op hoog niveau voor de managers.

•  Ontwikkel prototypes. Als u kunt ook enkele screenshots of voorbeeldcode in het ontwerp-document, zal dit helpen om uw ontwerp intentie te brengen. Het ontwikkelen van prototypes moet ook verminderen de tijd die wordt besteed codering.