¿Cómo documentar un algoritmo correctamente con datos de muestra?

10

Me pregunto qué debería contener la documentación de un algoritmo. No se puede encontrar una directriz adecuada para seguir. Tengo en mente incluir

  • resumen del algoritmo
  • descripción del algoritmo
  • diagramas de flujo
  • pseudocódigos
  • conjunto de datos de entrada de muestra (múltiple)
  • datos resultantes
  • pruebas unitarias
  • experimentos

El cliente solicita dicha documentación para: Mantener la confianza en nuestros propios números, así como para describir nuestro proceso a clientes potenciales para que sepan que estamos tomando medidas para verificar y verificar nuestros cálculos.

  • ¿Cómo se vería tal documentación? (ejemplo PDF)
  • ¿Qué incluirías más en esta documentación?
  • Lo que enumeré es que bueno, ¿o esto debería documentarse de alguna manera diferente?
  • ¿Cómo buscarías en Google tales muestras de documentación?
Pentium10
fuente

Respuestas:

4

Algunos puntos más:

  1. Análisis de rendimiento / punto de referencia con entradas de muestra y entornos.
  2. Alterna con el algoritmo (si existe), realmente ayuda a las personas nuevas y para el análisis de comparación.
  3. Ejemplos de mejores y peores escenarios / entradas.

¿Cómo se vería tal documentación?
A los clientes / usuarios (¿/ administradores?) No les gusta el PDF, sin embargo, encuentran que los PPT son muy interesantes, al mismo tiempo que las empresas insistirán en el PDF. Por lo tanto, debe tener un documento de dos niveles, uno en PPT solo para "explicar en 20 minutos" y otro en PDF que cubra los detalles sangrientos del juego.

Suraj Chandran
fuente
Además, si los Algos alternativos están disponibles, debe comparar la eficiencia de ambos Algos.
¿Alguna muestra que pueda mostrar?
Pentium10