Gostaria de saber o que deve conter uma documentação de algoritmo? Não é possível localizar uma orientação adequada a seguir. Eu tenho em mente incluir
- resumo do algoritmo
- descrição do algoritmo
- fluxogramas
- pseudo códigos
- conjunto de dados de entrada de amostra (múltiplo)
- dados de saída
- testes de unidade
- experimentos
O cliente solicita essa documentação para: Manter a confiança em nossos próprios números, bem como descrever nosso processo para clientes em potencial, para que eles saibam que estamos tomando medidas para verificar e verificar nossos cálculos.
- Como seria essa documentação? (exemplo PDF)
- O que você incluiria mais nesta documentação?
- O que eu enumerei é bom ou isso deve ser documentado de forma diferente?
- Como você pesquisaria no Google esses exemplos de documentação?