开发者最佳实践2 – 继续下一步之前完成你的文档

我曾经弄砸了我的计算机与应用硕士学位,我当时特别喜欢写代码,即使没有完全弄明白也没有完整的文档。在软件开发过程中没有任何设计文档和测试用例文档……直接跳到了编码阶段。

在最后阶段,我发现自己遇到了大麻烦,很快我就意识到文档是成为成功的软件开发人员、测试员、架构师的钥匙。

当你开发大型软件的小部分前,你应该先回答下面这些问题:

  • 需求说明书在哪里?
  • 影响分析文档在哪里?     
  • 设计文档在哪里?     
  • 你是否已经把所有的假设、限制合理的文档化了?     
  • 你是否已经评审了以上这些文档?     
  • 你拿到了所有利益人(stockholders)对以上文档的签字吗?

一旦能够肯定的回答上面的问题,你就可以放心的开始编码了。许多公司可能要求遵守严格的规则,但是也有很多公司没有这些要求。但是最好的实践是在开始软件编码前完成所有必须的文档,且获得适当的批准。

你今天学到的东西是在为你的明天做准备! 所以,尽可能完善所有文档是最好的实践之一。

一些重要的文档将为你的未来做好准备,譬如:

  • 设计途径    
  •  技巧提示     
  • 特殊函数、命令、指令     
  • 经验教训     
  • 特殊情况     
  • Debugging的方法     
  • 最佳的实践     
  • 能在未来帮助你的任何事情

使用电子文档的方式保存文档不会给你增加任何开支。所以让我们开始维护必要的文档吧。

注:本文由奔跑翻译,前往查看原文

分享到: 更多
版权申明:

本站保留所有原创文章的版权,本站地址:奔跑的博客[http://www.elecbench.com]

原创文章转载时请注明出处,并添加文章所在页面的链接:http://www.elecbench.com/%e5%bc%80%e5%8f%91%e8%80%85%e6%9c%80%e4%bd%b3%e5%ae%9e%e8%b7%b52-%e7%bb%a7%e7%bb%ad%e4%b8%8b%e4%b8%80%e6%ad%a5%e4%b9%8b%e5%89%8d%e5%ae%8c%e6%88%90%e4%bd%a0%e7%9a%84%e6%96%87%e6%a1%a3/

本站所有 2010年3月4日 以后发表、未标明为“转载”的文章均是本站原创。

发表评论


(设置自己的个性头像)

*

申请属于你的免费顶级域名