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?
quelle