ドキュメントが鍵です

ベストプラクティス2-次のステップの前にドキュメントを完成させます

私はコンピューターとアプリケーションの修士号を取得しており、要件を完全に理解して文書化しなくても、ソースコードを書くことに情熱を注いでいました。設計ドキュメントとテストケースドキュメントは、ソフトウェア開発ライフサイクルのどこにもありませんでした....コーディングへの直接のジャンプがありました。

後の段階で私は大きな問題に直面し、すぐに気づきました Documentation is the Key 成功するソフトウェア開発者、テスター、またはアーキテクトになるため。

小規模または大規模なソフトウェアの開発を開始する前に、次の質問に対する回答が必要です。

  • 要件仕様はどこにありますか?

  • 影響分析ドキュメントはどこにありますか?

  • 設計ドキュメントはどこにありますか?

  • すべての仮定、制限を適切に文書化しましたか?

  • すべてのドキュメントのレビューを行いましたか?

  • すべての利害関係者からのすべてのドキュメントを承認しましたか?

上記のすべての質問に対して肯定的な回答が得られたら、安全でコーディングに進む準備ができています。多くの組織は従うべき厳格な規則を持っていますが、他の組織は従わないでしょう。ベストプラクティスは、ソフトウェアコーディングに進む前に、必要なすべてのドキュメントを完成させ、適切な承認を取得することです。

あなたが今日学んだことは、明日の準備をします!

したがって、ここでも、可能な限りドキュメントを用意することがベストプラクティスの1つです。将来に備えるための重要なドキュメントは次のとおりです。

  • 設計アプローチ
  • ヒントとコツ
  • 特別な機能、コマンド、および命令
  • 学んだ教訓
  • 独特の状況
  • デバッグ方法
  • ベストプラクティス
  • 将来あなたを助けることができるものは何でも

ドキュメントを電子的に保持することはあなたに費用がかかりません。それでは、必要なドキュメントの保守を始めましょう。