Política de documentação

Nesta página, descrevemos a política da AML AI para diferentes artefatos de documentação.

Tipo de artefato	Descrição	Frequência de geração
Guias do usuário, guias de instruções e a Referência da API	Essa documentação abrange a definição do produto e é atualizada à medida que os recursos são alterados. Isso inclui o seguinte: Guias do usuário: manuais passo a passo sobre como usar o produto de IA de AML Guias de instruções: documentos que informam aos usuários como concluir tarefas importantes Referência da API: descrições exaustivas de funções, classes e métodos	Atualizado com cada versão do produto e atualizado periodicamente conforme necessário
Notas da versão	Esta documentação contém avisos de mudanças nos recursos e na funcionalidade do produto, incluindo suporte a métricas e resultados de desempenho.	Fornecido com cada lançamento de versão do produto, incluindo APIs e versões de mecanismo
Documentos conceituais (inclui documentação de suporte à governança do modelo)	Um documento que descreve casos de uso, abordagens, soluções selecionadas e metodologias seguidas para decisões significativas que afetam o modelo. Quando a funcionalidade for reservada, um documento conceitual descreve o anterior, mas pode optar por excluir áreas específicas da solução se elas forem IP protegido. Nesse caso, são apresentadas a abordagem geral, a metodologia e a validação da técnica.	Fornecido quando há um lançamento de versão principal do mecanismo, que inclui mudanças significativas no design do produto ou nas metodologias de avaliação que podem exigir a atualização dos materiais de suporte de governança (disponível sob solicitação para clientes de IA do AML)
Relatórios automáticos	Saídas quantitativas e/ou registros de auditoria	Gerado após chamada de API