Je me demande ce que devrait contenir une documentation d'algorithme? Impossible de trouver une ligne directrice appropriée à suivre. J'ai en tête d'inclure
- résumé de l'algorithme
- description de l'algorithme
- organigrammes
- pseudo codes
- exemple de jeu de données d'entrée (multiple)
- des données de sortie
- tests unitaires
- expériences
Le client demande une telle documentation pour: maintenir la confiance dans nos propres numéros ainsi que pour décrire notre processus aux clients potentiels afin qu'ils sachent que nous prenons des mesures pour vérifier et vérifier nos calculs.
- À quoi ressemblerait une telle documentation? (exemple PDF)
- Que voudriez-vous inclure de plus dans cette documentation?
- Ce que j'ai énuméré, c'est bien, ou cela devrait-il être documenté différemment?
- Comment rechercheriez-vous dans Google de tels échantillons de documentation?