Dokumentationsrichtlinie

Auf dieser Seite wird die AML AI-Richtlinie für verschiedene Dokumentationsartefakte beschrieben.

Artefakttyp	Beschreibung	Häufigkeit der Generierung
Nutzerhandbücher, Anleitungen und die API-Referenz	Diese Dokumentation enthält die Definition des Produkts. Die Dokumentation wird aktualisiert, wenn sich die Funktionen ändern. Dazu gehört Folgendes: Nutzerhandbücher: Schritt-für-Schritt-Anleitungen zur Verwendung des AML AI-Produkts Anleitungen: Dokumente, die Nutzern zeigen, wie sie wichtige Aufgaben erledigen API-Referenz: Ausführliche Beschreibungen von Funktionen, Klassen und Methoden	Wird bei jeder Produktversion aktualisiert und bei Bedarf regelmäßig aktualisiert
Versionshinweise	In dieser Dokumentation finden Sie Ankündigungen von Änderungen an Produktfunktionen, einschließlich der Unterstützung von Leistungsmesswerten und -ergebnissen.	Wird mit jedem Produktversionsrelease bereitgestellt, einschließlich APIs und Engine-Versionen
Concept Docs (einschließlich der Dokumentation zur Modell-Governance)	Ein Dokument, in dem Anwendungsfälle, Ansätze, ausgewählte Lösungen und Methoden für wichtige Entscheidungen beschrieben werden, die sich auf das Modell auswirken. Wenn die Funktionalität proprietär ist, wird das obige Konzept in einem Concept Doc beschrieben, wobei bestimmte Lösungsbereiche unter Umständen ausgeschlossen werden, wenn es sich um geschütztes geistiges Eigentum handelt. In diesem Fall werden der allgemeine Ansatz, die Methodik und die Validierung des Verfahrens vorgestellt.	Wird bereitgestellt, wenn eine Hauptversionsversion veröffentlicht wird, die erhebliche Änderungen im Produktdesign oder an Bewertungsmethoden mit sich bringt, die möglicherweise eine Aktualisierung der Supportmaterialien für die Governance erfordern (auf Anfrage für AML AI-Kunden verfügbar).
Automatisierte Berichte	Quantitative Ausgaben und/oder Audit-Logs	Beim API-Aufruf generiert