文档是关键

最佳实践2 - 在下一步之前完成您的文档

我获得了计算机与应用硕士学位，我非常热衷于编写源代码，即使没有完全理解和记录需求。设计文档和测试用例文档在软件开发生命周期中根本不存在……直接跳到编码。

在后期，我发现自己陷入了大麻烦，很快我意识到**文档是关键**，才能成为成功的软件开发人员、测试人员或架构师。

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

• 需求规格说明书在哪里？

• 影响分析文档在哪里？

• 设计文档在哪里？

• 您是否已妥善记录所有假设和限制？

• 您是否已对所有文档进行了审查？

• 您是否已获得所有利益相关者对所有文档的签字？

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

你今天学到的东西，为明天的你做准备！

所以，再次强调，尽可能多地编写文档是最佳实践之一。一些可以为将来做准备的重要文档包括：

• 设计方法
• 技巧和窍门
• 特殊函数、命令和指令
• 经验教训
• 特殊情况
• 调试方法
• 最佳实践
• 任何将来可能对您有帮助的内容

电子文档不会花费你任何成本。所以让我们开始维护所需的文档吧。