Bagaimana cara mendokumentasikan suatu algoritma dengan benar dengan data sampel?

Saya bertanya-tanya apa yang seharusnya berisi dokumentasi algoritma? Tidak dapat menemukan panduan yang tepat untuk diikuti. Ada yang ingin saya sertakan

• ringkasan algoritma
• deskripsi algoritma
• diagram alur
• kode semu
• set input data sampel (banyak)
• data keluaran
• tes unit
• percobaan

Klien meminta dokumentasi semacam itu untuk: Mempertahankan kepercayaan pada nomor kami sendiri serta untuk menggambarkan proses kami kepada pelanggan potensial sehingga mereka tahu kami mengambil langkah-langkah untuk memeriksa dan memverifikasi perhitungan kami.

• Bagaimana kelihatan seperti dokumentasi seperti itu? (contoh PDF)
• Apa yang akan Anda sertakan lebih banyak dalam dokumentasi ini?
• Apa yang saya sebutkan itu baik, atau ini harus entah bagaimana didokumentasikan secara berbeda?
• Bagaimana Anda mencari sampel dokumentasi di Google?

Beberapa poin lagi:

1. Analisis kinerja / tolok ukur dengan input sampel dan lingkungan.
2. Alternatif untuk algoritma (jika ada), sangat membantu untuk orang baru, dan untuk analisis perbandingan.
3. Contoh skenario / input kasus terbaik dan terburuk.

Bagaimana kelihatan seperti dokumentasi seperti itu?
Cusotmers / Pengguna (/ Manajer?) Tidak suka PDF, mereka menemukan PPT sangat menarik, pada saat yang sama bisnis akan bersikeras pada PDF. Jadi, Anda harus memiliki dokumen dua tingkat, satu di PPT hanya untuk "menjelaskan dalam 20 menit" dan lainnya dalam PDF yang mencakup detail mengerikan dari permainan.