サンプルデータを使用してアルゴリズムを適切に文書化する方法は？
アルゴリズムのドキュメントには何を含める必要があるのでしょうか。従うべき適切なガイドラインが見つかりません。含めることを念頭に置いています
- アルゴリズムの要約
- アルゴリズムの説明
- フローチャート
- 疑似コード
- 入力データセットのサンプル（複数）
- 出力データ
- 単体テスト
- 実験
クライアントは次のような文書を要求します：私たち自身の数値の信頼を維持し、潜在的な顧客に私たちのプロセスを説明して、私たちが計算をチェックおよび検証するための手順を踏んでいることを彼らに知らせます。
- そのようなドキュメントはどのように見えますか？ （PDFの例）
- このドキュメントに何を追加しますか？
- 私が列挙したものはそれで良いですか、またはこれはどういうわけか異なって文書化されるべきですか？
- このようなドキュメントサンプルをGoogleでどのように検索しますか？
さらにいくつかのポイント：
- サンプルの入力と環境でのパフォーマンス分析/ベンチマーク。
- アルゴリズムの代替（存在する場合）は、新しい人や比較分析に非常に役立ちます。
- 最良および最悪のシナリオ/入力の例。
このようなドキュメントはどのように見えますか？
Cusotmers/Users（/ Managers？）はPDFが好きではありませんが、PPTは非常に興味深いと感じますが、同時にビジネスはPDFを要求します。したがって、2つのレベルのドキュメントが必要です。1つはPPT「20分で説明する」だけで、もう1つはPDFにあります。ゲーム。