Wie dokumentiert man Software-Algorithmen?

Question

Ich arbeite an einem großen Projekt für einen Hochschulauftrag, wir entwickeln eine Anwendung, die von einem Unternehmen verwendet wird, um Angebote für ihre verschiedenen Dienste zu erstellen.

ich die Algorithmen in einer Art und Weise dokumentieren müssen, dass der Client auf, um abmelden können sicher die Art, wie wir die Preise berechnen korrekt

Bisher habe ich versucht, eine große Flussdiagramm mit Entscheidungen Diamanten mit wie in der Modellierung von Informationssystemen, aber es erweist sich als übertrieben für selbst einfache Algorithmen.

Kann jemand bitte einige Möglichkeiten vorschlagen, dies zu tun? Es muss so wenig wie Software-Code wie möglich sein, und genug für den Client zu sehen, wie wir entscheiden, was die Preise

Answer 1

zitiert werden Vielleicht sollten Sie dann Pseudocode verwenden.

Answer 2

Sie können Bildschirmdesigns vorbereiten, um den Benutzern zu zeigen, wie sich Ihr System tatsächlich verhält.

Answer 3

Nun, der übliche Weg, um Algorithmen zu dokumentieren, ist das Schreiben von Papieren. Wenn Ihre Kunden studiert haben, bin ich sicher, dass sie mit dem Lesen von Formeln vertraut sind.

Answer 4

Würde ein data flow diagrams helfen? Setzen Sie Pseudo-Code oder Mathematik in die Blasen. Ich hatte einige Erfolge bei der Kombination von Datenflussmodellen und Entitätsbeziehungsdiagrammen, aber es ist kein Standard.

Answer 5

Was ist mit Nassi-Shneiderman-Diagramm, es ist ein Diagramm aus strukturellen Programmierung. Ich denke, es ist gut, Entscheidungsflüsse zu zeigen.

http://en.wikipedia.org/wiki/Nassi%E2%80%93Shneiderman_diagram

Answer 6

Sie könnten einen Algorithmus Test-Bildschirm anzuzeigen und zu kommentieren die einzelnen Schritte durch die Berechnungen erstellen.

Answer 7

Erstellen Sie zwei Dokumente.

• Erstens: Das Geschäftsprozessmodell (BPM), das die Abfolge von Schritten zeigt erforderlich gemacht werden. Dies sollte mit den Details für jeden Schritt kommentiert werden.

  Zweite: Erstellen Sie eine Tabelle mit jedem Eingabedatenelement definiert, damit das Unternehmen sehen kann, dass Sie den Feldtyp für die Eingabe jedes Datenpunkts und die Regeln für jeden Datenpunkt verstehen. Wenn für die Berechnung eine Tabelle für den Schritt verwendet wird, definieren Sie den Eingabesuchwert aus der Tabelle. So wissen Sie für jeden Schritt, woher die Daten kommen und gehen. Ihre Tabelle kann den Link zum BPM enthalten, damit sie jeden Datenpunkt im BPM durchlaufen und sehen kann, von wo er herkommt.