Come documentare correttamente un algoritmo con dati di esempio?

Naviga le tue risposte
9

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

  • riepilogo dell'algoritmo
  • descrizione dell'algoritmo
  • diagrammi di flusso
  • pseudo codici
  • set di dati di input del campione (multiplo)
  • dati di output
  • unit test
  • 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 provvedimenti per verificare e verificare i nostri calcoli.

  • Come apparirebbe una tale documentazione? (esempio PDF)
  • Cosa includere di più in questa documentazione?
  • Quello che ho elencato è buono, o questo dovrebbe essere in qualche modo documentato in modo diverso?
  • Come faresti a cercare in Google questi esempi di documentazione?
posta Pentium10 18.07.2011 - 09:40
fonte

1 risposta

4

Altri punti:

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

Come sarebbe una tale documentazione?
I Cusotmers / Users (/ Managers?) Non amano i PDF, ma trovano che i PPT siano molto interessanti, ma allo stesso tempo il business insisterà sul PDF. Quindi dovresti avere un documento a due livelli, uno in PPT solo per "spiegare in 20 minuti" e altro in PDF che copra i dettagli cruenti del gioco.

    
risposta data 18.07.2011 - 09:45
fonte

Leggi altre domande sui tag

Traduzione di testi più lunghi (visualizzazione e modelli di email) con gettext Meglio usare la monade degli errori con la convalida nelle funzioni monadiche o implementare la propria monade con la convalida direttamente nel proprio bind?