Ich versuche, eine Software zu dokumentieren, die ich ausführlich geschrieben habe. Eine SAS ist zu hoch und deckt die API nicht ab. Ich habe einige Beispiele für ein Sicherheitsdatenblatt online gefunden, sehe aber keinen Trend in ihrem Format.
Ich frage mich, ob es einige allgemeine Richtlinien zum Schreiben einer Software-Design-Spezifikation gibt oder was der beste Ansatz ist.
documentation
api
uml
design
sj755
quelle
quelle
Antworten:
Sie könnten viel schlimmeres tun, als mit der Beschreibung der Datenelemente des Software-Designdokuments DOD-STD-2167A zu beginnen .
Das US-Verteidigungsministerium hat viel Erfahrung mit Softwareentwicklung, viel mehr als jedes andere Unternehmen. Sie haben auch ein begründetes Interesse daran, tatsächlich Software zu erhalten, die die Aufgabe erfüllt und die später beibehalten werden kann. Sie haben sich große Mühe gegeben, um herauszufinden, welche Informationen in den verschiedenen Dokumenten enthalten sein müssen, die ein Softwareprojekt unterstützen. Dabei haben sie Erfahrungen aus einer großen Anzahl von Projekten und mehr als ein paar sehr teure Fehler verwendet.
Der Software Development Plan DID ( hier verfügbar ) enthält eine Reihe von Punkten, die behandelt werden müssen. Wenn Sie genau hinschauen, werden Sie feststellen, dass diese Abschnitte im Blut von Programmmanagern geschrieben sind, die diese Punkte nicht angesprochen haben.
quelle