Règle de documentation

Cette page décrit la règle AML AI pour différents artefacts de documentation.

Type d'artefact Description Fréquence de génération
Guides utilisateur, guides d'utilisation et documentation de référence de l'API

Cette documentation comprend la définition du produit. Elle est mise à jour à mesure que les fonctionnalités évoluent. Voici quelques exemples:

  • Guides de l'utilisateur: manuels détaillés sur l'utilisation du produit AML AI
  • Guides d'utilisation: documents qui indiquent aux utilisateurs comment accomplir les tâches importantes
  • Documentation de référence de l'API: descriptions exhaustives des fonctions, classes et méthodes

Mises à jour à chaque version de produit et mises à jour périodiquement selon les besoins
Notes de version Cette documentation présente les modifications apportées aux fonctionnalités du produit, y compris les métriques de performances et les résultats associés. Fourni avec chaque version de produit, y compris les API et les versions de moteur
Documentation conceptuelle (inclut une documentation d'aide concernant la gouvernance des modèles)

Document décrivant les cas d'utilisation, les approches, une sélection de solutions et les méthodologies appliquées pour prendre des décisions importantes concernant le modèle.

Lorsque la fonctionnalité est propriétaire, un document conceptuel décrit ce qui précède, mais peut choisir d'exclure des zones de solutions spécifiques s'il s'agit d'une adresse IP protégée. Dans ce cas, l'approche générale, la méthodologie et la validation de la technique sont présentées.

Fourni lors d'une version majeure du moteur, qui entraîne des modifications importantes des méthodologies de conception du produit ou d'évaluation pouvant nécessiter une mise à jour des ressources d'aide concernant la gouvernance (disponible sur demande pour les clients AML AI)
Rapports automatisés Sorties quantitatives et/ou journaux d'audit Généré lors d'un appel d'API