Política de documentação

Esta página descreve a política de IA de AML para diferentes artefactos de documentação.

Tipo de artefacto Descrição Frequência de geração
Guias do utilizador, guias de instruções e referência da API

Esta documentação compreende a definição do produto; a documentação é atualizada à medida que as capacidades mudam. Isto inclui o seguinte:

  • Guias do utilizador: manuais passo a passo sobre como usar o produto de IA de AML
  • Guias de instruções: documentos que indicam aos utilizadores como concluir tarefas importantes
  • Referência da API: descrições exaustivas de funções, classes e métodos

Atualizado com cada lançamento de produto e atualizado periodicamente, conforme necessário
Notas de lançamento Esta documentação fornece anúncios de alterações às funcionalidades dos produtos e à funcionalidade, incluindo métricas de desempenho e resultados de apoio. Fornecidas com cada lançamento da versão do produto, incluindo versões de APIs e do motor
Concept Docs (inclui documentação de apoio técnico para a governação de modelos)

Um documento que descreve exemplos de utilização, abordagens, soluções selecionadas e metodologias seguidas para decisões significativas que afetam o modelo.

Quando a funcionalidade é proprietária, um documento de conceito descreve o que precede, mas pode optar por excluir áreas de solução específicas se estas forem IP protegida. Neste caso, é apresentada a abordagem geral, a metodologia e a validação da técnica.

Fornecido quando existe um lançamento de uma versão principal do motor, que inclui uma alteração significativa no design do produto ou nas metodologias de avaliação que podem exigir a atualização dos materiais de apoio à governação (disponíveis a pedido para clientes de IA de AML)
Relatórios automatizados Resultados quantitativos e/ou registos de auditoria Gerado após a chamada API