📜  文档是关键

📅  最后修改于: 2020-10-16 07:51:38             🧑  作者: Mango


最佳做法2-下一步完成文件

我已经淘汰了计算机与应用程序专业的硕士,即使没有完全理解和记录需求,我仍然非常热衷于编写源代码。设计文档和测试案例文档在软件开发生命周期中无处可寻……直接跳转到了编码。

在后来的阶段,我发现自己陷入了大麻烦,不久我就意识到文档是成为成功的软件开发人员,测试人员或架构师的关键。

电脑文件

在开始开发小型或大型软件之前,您应该对以下问题有答案:

  • 需求规范在哪里?

  • 影响分析文件在哪里?

  • 设计文件在哪里?

  • 您是否正确记录了所有假设和限制?

  • 您是否已审查所有文件?

  • 您是否已从所有利益相关者的所有文档上签字?

一旦您对以上所有问题都有肯定的答案,您就可以安全地开始进行编码了。许多组织将有严格的规则要遵循,但其他组织则没有。最佳实践是在继续进行软件编码之前,完成所有必需的文档并获得适当的批准。

今天学到的东西,为明天做好准备!

因此,再次拥有尽可能多的文档是最佳实践之一。很少有重要文件为您将来做准备:

  • 设计方法
  • 技巧和窍门
  • 特殊功能,命令和说明
  • 得到教训
  • 特殊情况
  • 调试方法
  • 最佳实践
  • 将来有什么可以帮助您的

以电子方式保存文件不会花费您任何费用。因此,让我们开始维护必需的文档。