Ein Software- Design-Dokument ist das "wie " des Software-Lebenszyklus -Dokumentation. Es wird beschrieben, wie die Software-Anforderungen umgesetzt werden sollten und es gibt den Programmierern eine Blaupause zu folgen. Die Software Design-Dokument ist ein schriftlicher Vertrag zwischen Ihnen, Ihr Team, Ihre Projektleiter und Ihre Kunden. Wenn Sie Ihre Annahmen , Entscheidungen und Risiken dokumentieren , gibt es die Team-Mitglieder und Interessengruppen die Gelegenheit zu vereinbaren oder zu fragen, für Klarstellungen und Änderungen vorbehalten. Sobald die Software-Design Dokument von den entsprechenden Parteien genehmigt wird , wird es eine Grundlinie für sie die Änderungen im Rahmen des Projektes . Anleitung
1
Untersuchen Sie die Formatierung von Dokumenten /Vorlage in der Software-Anforderungen Dokument verwendet werden. Dies beinhaltet Titelseite , Seitennummerierung Format , Abschnitt Zahlen und Revision der Geschichte. Verwenden Sie die gleiche oder ein ähnliches Dokument Format für die Software-Design Dokument
2
Integrieren Sie einige , wenn nicht alle , aus den folgenden Elementen :
- Hohe Zusammenfassung für
- Definitionen von allen nicht-Standard- Symbole , Formen , Akronyme und einzigartige Begriffe im Dokument
- Wie jede Anforderung
erreicht werden - Annahmen
- Constraints
- Software Risikoanalyse
- Entwicklung Verfahren und Coding Guidelines
- Standard- Sprachen und Werkzeuge
- Definitionen von Variablen und eine Beschreibung, wo sie verwendet werden,
- logische Struktur und logische Verarbeitungsschritte
- Fehler -, Alarm- und Warnmeldungen
- Sicherheitsmaßnahmen
- Leistung
- Zuverlässigkeit
3
Überlegen Sie, wie das Design-Dokument zu strukturieren. Dies ist besonders wichtig, wenn Sie mit dem Entwurf ein großes, komplexes System sind . Brechen Sie das System in logische Teile und verwenden Sie diese Teile, wie im Abschnitt Header in der Software-Design -Dokument. Wenn das System ist wirklich groß, erstellen Sie mehrere Design-Dokumente , Give jeder Umgang mit einem bestimmten Teil des Systems.
4
jedem Design-Element eine eindeutige Kennung . Dies wird es ermöglichen, zurück zu den anwendbaren Vorschriften und schließlich auf den anwendbaren Tests zurückgeführt werden.
5
einbeziehen detailliert genug für die Programmierer , während die einige High-Level- Zusammenfassungen für die Manager .
Seite 6
entwickeln Prototypen. Wenn Sie einige Screenshots oder Beispielcode im Design-Dokument gehören , wird dies dazu beitragen, Ihre Konstruktionsabsicht vermitteln . Entwicklung von Prototypen sollte auch eine Verringerung der Zeit, die aufgewendet Codierung werden .