Come documentare correttamente un algoritmo con dati di esempio?

Mi chiedo cosa dovrebbe contenere una documentazione dell'algoritmo? Impossibile trovare una linea guida adeguata da seguire. Ho in mente di includere

• riepilogo dell'algoritmo
• descrizione dell'algoritmo
• diagrammi di flusso
• pseudo codici
• set di dati di input di esempio (multipli)
• dati di output
• test unitari
• esperimenti

Il cliente richiede tale documentazione per: Mantenere la fiducia nei nostri numeri e descrivere il nostro processo ai potenziali clienti in modo che sappiano che stiamo prendendo delle misure per verificare e verificare i nostri calcoli.

• Come sarebbe una tale documentazione? (esempio PDF)
• Cosa includeresti di più in questa documentazione?
• Quello che ho elencato è così buono, o questo dovrebbe essere in qualche modo documentato diversamente?
• Come cerchereste su Google esempi di documentazione del genere?

Alcuni altri punti:

1. Analisi delle prestazioni / benchmark con input e ambienti di esempio.
2. Si alterna all'algoritmo (se esiste), aiuta davvero per le nuove persone e per l'analisi di confronto.
3. Esempi di scenari / input migliori e peggiori.

Come sarebbe una tale documentazione?
Ai clienti / utenti (/ gestori?) Non piacciono i PDF, trovano molto interessanti i PPT, ma allo stesso tempo gli affari insistono sul PDF. Quindi dovresti avere un documento a due livelli, uno in PPT solo per "spiegare in 20 minuti" e l'altro in PDF che copre i dettagli cruenti del gioco.