アルゴリズムのドキュメントには何を含める必要があるのでしょうか。従うべき適切なガイドラインが見つかりません。含めることを心に留めています
- アルゴリズムの要約
- アルゴリズムの説明
- フローチャート
- 疑似コード
- 入力データセットのサンプル(複数)
- 出力データ
- 単体テスト
- 実験
クライアントは次のような文書を要求します。自社の数値に自信を持たせるとともに、プロセスを見込み顧客に説明して、計算をチェックおよび検証するための手順を踏んでいることを顧客に説明します。
- そのようなドキュメントはどのように見えますか?(PDFの例)
- このドキュメントに何を追加しますか?
- 私が列挙したものはそれで良いですか、またはこれはどういうわけか異なって文書化されるべきですか?
- このようなドキュメントサンプルをGoogleでどのように検索しますか?