Wie kann man einen Algorithmus mit Beispieldaten richtig dokumentieren?

10

Ich frage mich, was eine Algorithmusdokumentation enthalten sollte. Ich kann keine richtige Richtlinie finden, der ich folgen kann. Ich habe vor, aufzunehmen

  • Zusammenfassung des Algorithmus
  • Beschreibung des Algorithmus
  • Flussdiagramme
  • Pseudocodes
  • Beispiel-Eingabedatensatz (mehrfach)
  • Ausgabedaten
  • Unit-Tests
  • Experimente

Der Kunde fordert eine solche Dokumentation an, um: das Vertrauen in unsere eigenen Zahlen zu wahren und potenziellen Kunden unseren Prozess zu beschreiben, damit diese wissen, dass wir Schritte unternehmen, um unsere Berechnungen zu überprüfen und zu verifizieren.

  • Wie würde eine solche Dokumentation aussehen? (Beispiel PDF)
  • Was würden Sie mehr in diese Dokumentation aufnehmen?
  • Was ich aufgezählt habe, ist das gut, oder sollte dies irgendwie anders dokumentiert werden?
  • Wie würden Sie in Google nach solchen Dokumentationsbeispielen suchen?
Pentium10
quelle

Antworten:

4

Noch ein paar Punkte:

  1. Leistungsanalyse / Benchmark mit Beispieleingaben und Umgebungen.
  2. Alternativen zum Algorithmus (falls vorhanden) helfen wirklich neuen Leuten und bei der Vergleichsanalyse.
  3. Beispiele für Best- und Worst-Case-Szenarien / Eingaben.

Wie würde eine solche Dokumentation aussehen?
Kunden / Benutzer (/ Manager?) Mögen PDF nicht, sie finden PPTs jedoch sehr interessant, gleichzeitig wird das Geschäft auf PDF bestehen. Sie sollten also ein zweistufiges Dokument haben, eines in PPT, nur um es in 20 Minuten zu erklären, und eines in PDF, das die wichtigsten Details des Spiels abdeckt.

Suraj Chandran
quelle
Auch wenn die alternativen Algos verfügbar sind, müssen Sie die Effizienz beider Algos vergleichen.
Irgendwelche Beispiele, die Sie zeigen können?
Pentium10