Comment documenter correctement un algorithme avec des exemples de données?

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?

Quelques points supplémentaires:

1. Analyse de performance / benchmark avec des échantillons d'entrées et d'environnements.
2. L'alternative à l'algorithme (s'il existe) aide vraiment les nouvelles personnes et l'analyse de comparaison.
3. Exemples de scénarios / entrées dans le meilleur et le pire des cas.

À quoi ressemblerait une telle documentation?
Les utilisateurs / utilisateurs (/ gestionnaires?) N'aiment pas le PDF, mais ils trouvent les PPT très intéressants, en même temps, les entreprises insisteront sur le PDF. Vous devriez donc avoir un document à deux niveaux, l'un en PPT juste pour "expliquer en 20 minutes" et l'autre en PDF qui couvre les détails sanglants du jeu.