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?