Jak prawidłowo udokumentować algorytm przykładowymi danymi?

Zastanawiam się, co powinna zawierać dokumentacja algorytmu? Nie można znaleźć właściwej wytycznej do naśladowania. Mam na myśli to

• podsumowanie algorytmu
• opis algorytmu
• schematy blokowe
• pseudo kody
• przykładowy zestaw danych wejściowych (wiele)
• dane wyjściowe
• testy jednostkowe
• eksperymenty

Klient prosi o taką dokumentację, aby: Utrzymać zaufanie do własnych numerów, a także opisać nasz proces potencjalnym klientom, aby wiedzieli, że podejmujemy kroki w celu sprawdzenia i weryfikacji naszych obliczeń.

• Jak wyglądałaby taka dokumentacja? (przykład PDF)
• Co byś dodał więcej w tej dokumentacji?
• To, co wyliczyłem, jest tak dobre, czy też powinno to być jakoś inaczej udokumentowane?
• Jak wyszukiwałbyś w Google próbki dokumentacji?

Kilka dodatkowych punktów:

1. Analiza wydajności / test porównawczy z przykładowymi danymi wejściowymi i środowiskami.
2. Zastępuje algorytm (jeśli istnieje), naprawdę pomaga nowym osobom i analizie porównawczej.
3. Przykłady najlepszych i najgorszych scenariuszy / danych wejściowych.

Jak wyglądałaby taka dokumentacja?
Klienci / Użytkownicy (/ Menedżerowie?) Nie lubią plików PDF, uważają PPT za bardzo interesujące, a jednocześnie firmy będą nalegać na pliki PDF. Powinieneś więc mieć dwupoziomowy dokument, jeden w PPT, aby „wyjaśnić za 20 minut”, a drugi w PDF, który opisuje krwawe szczegóły gry.