So dokumentieren Sie Geschäftsregeln

Ich frage mich, was die formale und am häufigsten praktizierte Methode zur Dokumentation von Geschäftsregeln wäre. Wie dokumentieren Sie auch die UI-Spezifikationen von Entwicklungsartefakten (z. B. Dokumentieren von Formularfeldern und Verhalten von Schaltflächen in Formularen, Infotext usw.)?

Ich denke, @Joppe hat auf die UML hingewiesen, an die wir alle gedacht haben.

Use Case Diagrams bietet einen hervorragenden Überblick darüber, wie Akteure / Rollen mit dem System interagieren und was das System tut. Für Complexe Use Case, erklärt zusätzliche Informationen helfen textlich viel ( Vorbedingungen , Nachbedingungen , Abhängigkeiten von früheren UC Ausführungen , usw. )

Es gibt Diagramme, die auch auf verschiedenen Ebenen einen guten Überblick über das Geschäft bieten:

• Zustandsmaschinendiagramm, wenn Zustände dokumentiert werden sollen.
• Aktivitätsdiagramm . Für komplexe Anwendungsfälle müssen Sie möglicherweise tief in Details gehen. Die Detailgenauigkeit liegt bei Ihnen und hängt davon ab, wer die Dokumentation lesen wird. Diese Dokumentation mag nicht geschäftsmäßig erscheinen, aber mit der richtigen Detailgenauigkeit könnte dies der Fall sein.

Weisen Sie jedem Anwendungsfall einen Code zu (z. B. UC-1 , UC-n ). Diese werden später in der UI-Dokumentation hilfreich sein.

Für die UI-Dokumentation ist es heutzutage üblich, Wireframes zu erstellen . Ganz besser als Screenshots, weil es sauberer und einfacher aussieht. Schauen Sie sich zum Beispiel WireframeSketcher an

Wireframes sind möglicherweise nicht ausreichend dokumentiert. Führen Sie daher für jeden Bildschirm eine kurze Einführung durch und beschreiben Sie jede Schaltfläche. Verweisen Sie zusätzlich auf die betreffende UC auf dem Bildschirm ( siehe jetzt, warum UC-Codes nützlich sind ). Dadurch wird Ihre Dokumentation kohärent.

Tools wie Wireframesketcher bieten interaktive Modelle. Perfekt, um dem Kunden etwas Interaktives zu bieten, während Sie noch entwerfen oder entwickeln.

Vergessen Sie nicht, den Navigationsplan zu dokumentieren . Nav. Plan hat kein UML-Diagramm, aber stattdessen kann das State Machine-Diagramm verwendet werden. Es ist nicht für das, was es gemacht wurde, aber immer noch.

Denken Sie zum Schluss daran, an wen Sie sich wenden.

• Techniker : Sie können tief in Details gehen und technische Details verwenden.

• Kein Techniker : Vermeiden Sie technische Details (weder in Bezug auf Sprache noch Code). Versuchen Sie, klar und einfach zu sein und dieselben Begriffe / Wörter zu verwenden, die der Kunde verwendet. Denken Sie, Sie hätten keine Ahnung von Programmierung.

Die Dokumentation erfolgt häufig in Anwendungsfällen und anderen Prosaformen. Darüber hinaus kann es äußerst nützlich sein, UML-Diagramme und andere grafische Formulare zu haben, die Ihnen einen Überblick auf einer höheren Ebene geben und in kürzerer Zeit leicht zu verstehen sind als das Lesen von Seiten und Seiten.

Und nicht zuletzt sind Testfälle, die die Geschäftsregeln ausführen, die beste Dokumentation. Auf diese Weise können Sie den Code ändern und feststellen, dass Sie gegen eine Geschäftsregel verstoßen. Andernfalls besteht immer die Gefahr, dass die Dokumentation veraltet und veraltet ist.

Die wahrscheinlich häufigste Form sind Anwendungsfälle . Sie können sie mit Bildschirmmodellen und Beschreibungen ergänzen.

Ein Buch, das ich empfehlen würde, ist "Writing Effective Use Cases" von Alistair Cockburn. Es wird beschrieben, wie Sie Anwendungsfälle auf verschiedenen Detailebenen schreiben können, wie Sie vermeiden, auf den vorlagengesteuerten Ansatz hereinzufallen, und sich nur an die Dokumentation der erforderlichen und relevanten Bits halten.

Unabhängig davon, welche Methode Sie verwenden, stellen Sie sicher, dass sie aktiv gewartet werden können. Sie sollten lebende Dokumente sein. Die Unterbringung der Dokumente in einem Versionskontrollsystem oder einer Art Dokumentenverwaltungssystem wie Sharepoint kann einen großen Beitrag zur Aufrechterhaltung der Dokumente leisten. Das Verfolgen von Geschäftsregeln durch Word-Dokumente, die an E-Mails angehängt sind, ist eine schreckliche Möglichkeit, das Problem zu lösen, da mehrere Versionen im Umlauf sind.

Ich empfehle dringend, die Geschäftsregeln strikt von der Systemspezifikation zu trennen, indem nur Geschäftsregeln aus dem Anwendungsfall und dem UI-Design referenziert werden. Meine Lieblingstechnik ist: - Eine Liste der identifizierten Geschäftsregeln in einer Tabelle haben. - Geben Sie im Systemdesign, Anwendungsfallspezifikation, User Stories oder was auch immer, einfach "Der Benutzer gibt Informationen ein, wie in der Geschäftsregel BR012 angegeben", "Das System berechnet den Gesamtbetrag wie in der Geschäftsregel BR510 angegeben". Ich empfehle diesen Artikel http://www.allaboutrequirements.com/business-rules/

Versuchen Sie, ein UML-Diagramm mit Visual Studio-Code und dem Plant UML-Plugin zu generieren