Règles concernant la documentation

Cette page décrit le règlement sur l'IA AML pour différents artefacts de documentation.

Type d'artefact Description Fréquence de génération
Guides de l'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. Par exemple:

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

Mises à jour à chaque version du produit et régulièrement si nécessaire
Notes de version Cette documentation annonce les modifications apportées aux fonctionnalités et aux fonctionnalités des produits, y compris les métriques et les résultats de performances associés. Fourni avec chaque version du produit, y compris les API et les versions du moteur
Documentation sur les concepts (inclut la documentation d'assistance sur la gouvernance des modèles)

Document décrivant les cas d'utilisation, les approches, les solutions sélectionnées et les méthodologies suivies pour les décisions importantes affectant le modèle.

Lorsqu'une fonctionnalité est propriétaire, un document de concept décrit ce qui précède, mais peut choisir d'exclure des domaines de solution spécifiques s'ils sont protégés par des droits d'auteur. Dans ce cas, l'approche générale, la méthodologie et la validation de la technique sont présentées.

Fourni lors de la publication d'une version majeure du moteur, qui comprend des modifications importantes de la conception ou des méthodologies d'évaluation des produits pouvant nécessiter la mise à jour des documents d'assistance sur la gouvernance (disponibles sur demande pour les clients de l'IA AML)
Rapports automatisés Résultats quantitatifs et/ou journaux d'audit Généré lors de l'appel d'API