如何使用样本数据正确记录算法?


10

我想知道算法文档应包含什么?找不到合适的指导方针可以遵循。我想包括

  • 算法总结
  • 算法说明
  • 流程图
  • 伪代码
  • 样本输入数据集(多个)
  • 输出数据
  • 单元测试
  • 实验

客户要求提供这样的文档,以便:对我们自己的号码保持信心,并向潜在客户描述我们的流程,以便他们知道我们正在采取步骤来检查和验证我们的计算。

  • 这样的文档看起来如何?(示例PDF)
  • 您将在本文档中进一步包括什么?
  • 我列举的是那么好,还是应该以不同的方式记录下来?
  • 您将如何在Google中搜索此类文档样本?

Answers:


4

还有一些要点:

  1. 使用样本输入和环境进行性能分析/基准测试。
  2. 替代算法(如果存在),确实对新手和比较分析有帮助。
  3. 最佳和最坏情况方案/输入的示例。

这样的文档看起来如何?
客户/用户(/经理?)不喜欢PDF,尽管他们发现PPT非常有趣,但同时企业也会坚持使用PDF。因此,您应该有一个两级文档,一个是PPT文件,目的是“在20分钟内解释”,另一个是PDF文件,其中涵盖了游戏的细节。


另外,如果有备用算法,则必须比较两种算法的效率。

您可以显示任何样本吗?
Pentium10'7
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.