Norme relative alla documentazione

In questa pagina viene descritto il criterio AI AML per diversi artefatti della documentazione.

Tipo di elemento Descrizione Frequenza di generazione
Guide dell'utente, guide illustrative e riferimenti alle API

Questa documentazione comprende la definizione del prodotto; la documentazione viene aggiornata man mano che le funzionalità cambiano. Sono inclusi:

  • Guide dell'utente: manuali dettagliati su come utilizzare il prodotto AML AI
  • Guide illustrative: documenti che spiegano agli utenti come completare attività importanti
  • Riferimento API: descrizioni esaurienti di funzioni, classi e metodi

Aggiornamento a ogni release del prodotto e aggiornamenti periodici in base alle necessità
Note di rilascio Questa documentazione fornisce annunci di modifiche alle caratteristiche e alle funzionalità dei prodotti, incluso il supporto delle metriche sul rendimento e dei risultati. Forniti con la release di ogni versione del prodotto, incluse API e versioni del motore
Documenti concettuali (include la documentazione di supporto per la governance del modello)

Un documento che descrive i casi d'uso, gli approcci, le soluzioni selezionate e le metodologie utilizzate per prendere decisioni significative sul modello.

Dove la funzionalità è di proprietà, un documento concettuale descrive il precedente, ma può scegliere di escludere aree specifiche della soluzione se si tratta di IP protetti. In questo caso, vengono presentati l'approccio generale, la metodologia e la convalida della tecnica.

Fornito in caso di rilascio di una versione principale del motore, che include cambiamenti significativi nella progettazione dei prodotti o nelle metodologie di valutazione che possono richiedere l'aggiornamento dei materiali di supporto alla governance (disponibili su richiesta per i clienti dell'AI AML)
Report automatici Output quantitativi e/o audit log Generato al momento della chiamata API