文件是關鍵

最佳實踐2 - 在下一步之前完成您的文件

我獲得了計算機與應用碩士學位，我非常熱衷於編寫原始碼，即使沒有完全理解和記錄需求。設計文件和測試用例文件在軟體開發生命週期中根本不存在……直接跳到編碼。

在後期，我發現自己陷入了大麻煩，很快我意識到**文件是關鍵**，才能成為成功的軟體開發人員、測試人員或架構師。

在開始開發小型或大型軟體之前，您應該對以下問題有答案

• 需求規格說明書在哪裡？

• 影響分析文件在哪裡？

• 設計文件在哪裡？

• 您是否已妥善記錄所有假設和限制？

• 您是否已對所有文件進行了審查？

• 您是否已獲得所有利益相關者對所有文件的簽字？

一旦您對上述所有問題的答案都是肯定的，您就可以安全地進行編碼了。許多組織會有嚴格的規則需要遵守，但其他組織則沒有。最佳實踐是在進行軟體編碼之前完成所有必需的文件並獲得相應的批准。

你今天學到的東西，為明天的你做準備！

所以，再次強調，儘可能多地編寫文件是最佳實踐之一。一些可以為將來做準備的重要文件包括：

• 設計方法
• 技巧和竅門
• 特殊函式、命令和指令
• 經驗教訓
• 特殊情況
• 除錯方法
• 最佳實踐
• 任何將來可能對您有幫助的內容

電子文件不會花費你任何成本。所以讓我們開始維護所需的文件吧。