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?
fuente