Dokumentationsrichtlinie

Auf dieser Seite wird die Richtlinie für KI-gestützte AML für verschiedene Dokumentationsartefakte beschrieben.

Artefakttyp	Beschreibung	Häufigkeit der Generierung
Nutzerhandbücher, Anleitungen und API-Referenz	Diese Dokumentation enthält die Definition des Produkts. Sie wird aktualisiert, wenn sich die Funktionen ändern. Dazu gehören: Nutzerhandbücher: Detaillierte Anleitungen zur Verwendung des AML-KI-Produkts Anleitungen: Dokumente, in denen Nutzern erklärt wird, wie sie wichtige Aufgaben erledigen API-Referenz: Ausführliche Beschreibungen von Funktionen, Klassen und Methoden	Wird mit jeder Produktveröffentlichung und bei Bedarf regelmäßig aktualisiert
Versionshinweise	Diese Dokumentation enthält Ankündigungen zu Änderungen an Produktfunktionen und -eigenschaften, einschließlich unterstützender Leistungsmesswerte und ‑ergebnisse.	Wird mit jeder Produktversion bereitgestellt, einschließlich APIs und Engine-Versionen
Konzeptdokumente (einschließlich Dokumentation zur Unterstützung der Modellverwaltung)	Ein Dokument, in dem Anwendungsfälle, Ansätze, ausgewählte Lösungen und Methoden beschrieben werden, die bei wichtigen Entscheidungen berücksichtigt wurden, die sich auf das Modell auswirken. Wenn die Funktionen proprietär sind, wird in einem Konzeptdokument das Vorangehende beschrieben. Bestimmte Lösungsbereiche können jedoch ausgeschlossen werden, wenn sie geschütztes geistiges Eigentum sind. In diesem Fall werden der allgemeine Ansatz, die Methodik und die Validierung der Technik vorgestellt.	Wird bereitgestellt, wenn eine neue Hauptversion der Engine veröffentlicht wird, die erhebliche Änderungen am Produktdesign oder an den Bewertungsmethoden umfasst, die möglicherweise eine Aktualisierung der Governance-Supportmaterialien erfordern (auf Anfrage für Kunden von AML-KI verfügbar)
Automatisierte Berichte	Quantitative Ergebnisse und/oder Audit-Logs	Beim API-Aufruf generiert