Wie organisiert man Informationen über die Programmlösung?

Question

Нево. Ich entwickle ein System, das mit der Börse funktioniert (System, unten). Und es gibt eine Menge Informationen, die mein Programm benötigt, um mit diesem System zu interagieren. Dieses System hat formell deklarierte Schnittstelle, aber andere Details neben dieser Deklaration und Anforderungen an mein System werden oft geändert. Wie kann ich verfügbare Informationen über dieses System und die Anforderungen für mein Programm so organisieren, dass es sowohl leicht zu verstehen als auch einfach zu ändern ist.

Answer 1

Ihr erstes und vor allem Ziel ist es, Dokumentation für die relevanten APIs zu erstellen, die Ihr Programm bereitstellt, und dann Dokumentation für die Konfigurationsdateien hinzuzufügen, vielleicht sogar einen Validator für die Konfiguration einzurichten.

Automatisch erzeugter Inhalt von Code-Annotationen (abhängig von Ihrer Lösung, .NET XML-Dokumente oder PHPdoc, etc.) ist der erste Schritt - dies hilft Ihnen, Klassen und Interfaces zu dokumentieren, während Sie an dem Code arbeiten. Der nächste Schritt ist das Dokumentieren von Nicht-Code-Assets. Wenn Sie eine XML-Konfiguration haben, können Sie beispielsweise Schemas schreiben, für die eine Validierung durchgeführt werden soll.

Danach folgt die Integrationsdokumentation - Schritte, die auf dem Produktionsserver und/oder den Arbeitsstationen ausgeführt werden müssen, um die Anwendung zu installieren, zu aktualisieren und zu warten, einschließlich Support-Skripts.