BitFormation Consulting - Schreibe eine gute Software Design Document
Im Laufe der Jahre habe ich Hunderte von Design-Dokumente lesen und formuliert damit eine Meinung darüber, was ein ausgezeichnetes Design Papier macht. Dieser Artikel ist ein Versuch, sowohl gute als auch schlechte Eigenschaften zur Liste ich in Design-Dokumenten gesehen habe und kurz die Wirkung jedes dieser Merkmale zu beschreiben.
Die Funktionen eines Entwurfsdokuments
Stellen Sie einen Kollegen Programmierer, was der Zweck ein Designdokumentes des Schreibens ist, und die wahrscheinlichste Antwort, die Sie erhalten werden, ist „die Programmierer wissen zu lassen, was Code zu schreiben“. Das ist wahr, aber es gibt einige andere Gründe für das Schreiben dieses Dokuments, und sie sind keineswegs weniger wichtig.
- Kommunizieren Sie Ihr Design zu anderen:
Um Implementierer.
Selbstredend; das versteht sich auch ohne Worte. Die Programmierer müssen wissen, was Code zu schreiben."Um ihnen zu helfen, effizient zu schreiben, sollte das Design klar, vollständig und gut definiert.
Zum Nachfolger.
Es ist sehr wahrscheinlich, dass Sie zu einem bestimmten Zeitpunkt auf andere Projekte bewegen und lassen Sie jemand anderes übernehmen und verantwortlich für Ihr früheres Design sein. Diese Person wird verlängern sie, oder sie ändern, wie sich die Anforderungen ändern und das System entwickelt. Ihr ursprünglicher Entwurf Dokument wird dann eine unschätzbare Ressource Ihrer Designphilosophie, Absicht und Annahmen sein. Ihr Nachfolger wird wirklich braucht diese Einsicht um in der Lage zu sein, um das Design zu erweitern, ohne sie zu brechen."Gründlich Ihre Design-Philosophie und Absichten erklären.
Um Manager.
Sie haben wahrscheinlich jemand zu berichten. Dass jemand braucht, um die Ergebnisse Ihrer Arbeit zu sehen, entweder um den Fortschritt zu bewerten, oder ein besseres Verständnis für das Design und die Ressourcen zu gewinnen, es erfordern, wenn implementiert, oder sogar einen Hinweis zu bekommen, wie gut Sie sind, was Sie tun .
"Form trägt nur so viel Gewicht wie Inhalt. Das Dokument sorgfältig arrangiert und bearbeitet werden soll, so dass es ästhetisch sein würde, zu betrachten. Außerdem sollte der Leser in der Lage sein, Zeitschätzungen aus dem Inhalt abzuleiten.
"Das Dokument sollte vorzeigbar sein. Es sollte den verschiedenen Lesern einen Überblick über die Ziele und Kontext des Projekts geben, unter Berücksichtigung der Wahrscheinlichkeit, dass nicht alle Leser im Voraus wissen, was das Projekt ausmacht.
"Das Design-Dokument muss zwischen den verschiedenen Codierungs Phasen auf die Abhängigkeiten erarbeiten, und soll ein konkret Kosten für jede der Projektanforderungen befestigen.
Was darin enthalten
Am Ende dieses Artikels finden Sie die Vorlage eines generischen Design-Dokument finden zusammen mit Notizen zu erklären, was jeder Abschnitt enthalten soll. Neben dieser Vorlage zu verwenden und ändern es Ihre eigenen Bedürfnisse anzupassen, sollten Sie auf die folgenden Details:
Ein beschreibender Titel. 'Medusa High Level Design' ist viel besser als 'Die Medusa'. Denken Sie daran, dass die Leser wahrscheinlich mehrere Dokumente haben zu lesen, und sie brauchen eine Idee zu haben, welche Art von Dokument das ist.
Eine separate Titelseite, formatiert nach Ihren Unternehmensstandards. Das bedeutet in der Regel eine sehr große Schrift für den Titel verwenden.
Letzte Änderung Datum und Uhrzeit. Es ist überraschend zu sehen, wie viele Stunden in Sitzungen verschwendet werden, wenn mehrere Personen an verschiedenen Versionen des gleichen Dokuments suchen. Setzen Sie das Datum auf dem Deckblatt oder in der Fußzeile jeder Seite. Nutzen Sie Ihr Textverarbeitungsprogramm auto- Update-Funktion, um sicherzustellen, dass das Datum immer korrekt ist.
Seitenzahlen. Die dritte Ursache für verschwendete Zeit während der Sitzungen ist das Fehlen von Seitenzahlen. Die Seitennummerierung wird auch helfen, defekte Kopien mit fehlenden oder gemischten Seiten zu finden.
Ein Inhaltsverzeichnis. Wenn Sie Ihr Textverarbeitungsprogramm automatische Abschnittsnummerierung Funktion verwenden, ist es sehr wahrscheinlich, dass Sie nicht auch ein Inhaltsverzeichnis hinzufügen müssen hart arbeiten, um. Hin und wieder kann es jemandem das Leben leichter machen.
Techniques
Im Laufe der Jahre habe ich gelernt, und verschiedene Techniken und Tricks verwendet, um meine Design-Dokumente zu verbessern:
Stellen Sie sich vor, den Entwurf für Leute schreiben, die es in Ihrer Abwesenheit lesen. Versuchen Sie, ihre Fragen, trivial sowie prominente zu antizipieren, und stellen Sie sicher, dass Ihre Antworten im Text eingebettet sind.
Was ist zu vermeiden
Eine Design-Dokumentvorlage
In Verbindung stehende Artikel