Bir algoritma örnek verilerle düzgün bir şekilde nasıl belgelenir?

Bir algoritma dokümantasyonunun ne içermesi gerektiğini merak ediyorum? Takip edilecek uygun bir kılavuz bulunamıyor. Dahil etmeyi düşünüyorum

• algoritmanın özeti
• algoritmanın tanımı
• akış şemaları
• sahte kodlar
• örnek girdi veri seti (çoklu)
• çıktı verisi
• birim testleri
• deneyler

Müşteri, aşağıdakiler için böyle bir belge talep eder: Kendi numaralarımıza olan güveni korumak ve süreçlerimizi potansiyel müşterilere açıklamak, böylece hesaplamalarımızı kontrol etmek ve doğrulamak için adımlar attığımızı bilmeleri.

• Böyle bir belge nasıl görünür? (örnek PDF)
• Bu belgeye daha fazlasını ne eklersiniz?
• Numaralandırdığım şey iyi mi yoksa bu bir şekilde farklı mı belgelenmeli?
• Bu tür dokümantasyon örneklerini Google'da nasıl ararsınız?

Biraz daha puan:

1. Örnek girdiler ve ortamlarla performans analizi / kıyaslama.
2. Algoritmanın alternatifleri (varsa), yeni insanlara ve karşılaştırma analizine gerçekten yardımcı olur.
3. En iyi ve en kötü senaryo / girdi örnekleri.

Böyle bir belge nasıl görünür?
Cusotmers / Kullanıcılar (/ Yöneticiler?) PDF'yi sevmiyor, PPT'leri çok ilginç buluyorlar, aynı zamanda iş PDF'de ısrar edecek. Bu yüzden iki seviyeli bir dokümana sahip olmalısınız, biri PPT'de sadece "20 dakika içinde açıklamak" ve diğeri de oyunun kanlı ayrıntılarını kapsayan PDF'de.