Como documentar um algoritmo corretamente com dados de amostra?

10

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?
Pentium10
fonte

Respostas:

4

Mais alguns pontos:

  1. Análise de desempenho / benchmark com entradas e ambientes de amostra.
  2. Alterna para o algoritmo (se existir), realmente ajuda para novas pessoas e para análise de comparação.
  3. Exemplos de cenários / entradas de melhores e piores casos.

Como seria essa documentação?
Os usuários / usuários (/ gerentes?) Não gostam de PDF, mas consideram os PPTs muito interessantes, ao mesmo tempo em que as empresas insistem em PDF. Portanto, você deve ter um documento de dois níveis, um no PPT apenas para "explicar em 20 minutos" e outro em PDF que cubra os detalhes sangrentos do jogo.

Suraj Chandran
fonte
Além disso, se o Algos alternativo estiver disponível, você deverá comparar a eficiência de ambos.
Alguma amostra que você pode mostrar?
Pentium10