サンプルデータを使用してアルゴリズムを適切に文書化する方法


10

アルゴリズムのドキュメントには何を含める必要があるのでしょうか。従うべき適切なガイドラインが見つかりません。含めることを心に留めています

  • アルゴリズムの要約
  • アルゴリズムの説明
  • フローチャート
  • 疑似コード
  • 入力データセットのサンプル(複数)
  • 出力データ
  • 単体テスト
  • 実験

クライアントは次のような文書を要求します。自社の数値に自信を持たせるとともに、プロセスを見込み顧客に説明して、計算をチェックおよび検証するための手順を踏んでいることを顧客に説明します。

  • そのようなドキュメントはどのように見えますか?(PDFの例)
  • このドキュメントに何を追加しますか?
  • 私が列挙したものはそれで良いですか、またはこれはどういうわけか異なって文書化されるべきですか?
  • このようなドキュメントサンプルをGoogleでどのように検索しますか?

回答:


4

さらにいくつかのポイント:

  1. サンプルの入力と環境でのパフォーマンス分析/ベンチマーク。
  2. アルゴリズムの代替手段(存在する場合)は、新しい人や比較分析に役立ちます。
  3. 最良および最悪のシナリオ/入力の例。

そのようなドキュメントはどのように見えますか?
Cusotmers / Users(/ Managers?)はPDFが好きではありませんが、PPTは非常に興味深いと感じますが、同時にビジネスはPDFを要求します。したがって、2つのレベルのドキュメントが必要です。1つは「20分で説明」するためのPPTのドキュメント、もう1つはゲームの悲惨な詳細をカバーするPDFのドキュメントです。


また、代替アルゴが利用可能な場合は、両方のアルゴの効率を比較する必要があります。

見せられるサンプルはありますか?
Pentium10
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.