Developers-best-practices-documentation-is-key

提供:Dev Guides
移動先:案内検索

ドキュメントが鍵

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

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

後の段階で、私は大きな問題に直面し、すぐにソフトウェア開発者、テスター、またはアーキテクトとして成功するために、*ドキュメントが鍵*であることに気付きました。

コンピュータードキュメント

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

  • 要件仕様はどこにありますか?
  • 影響分析ドキュメントはどこにありますか?
  • 設計文書はどこにありますか?
  • すべての仮定、制限を適切に文書化しましたか?
  • すべてのドキュメントのレビューを完了しましたか?
  • すべての利害関係者からのすべての文書を承認しましたか?

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

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

したがって、できる限りドキュメントを作成することは、ベストプラクティスの1つです。 将来のために準備する重要な文書はほとんどありません。

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

文書を電子的に保管するのに費用はかかりません。 それでは、必要なドキュメントの管理を始めましょう。