Programming-methodologies-program-documentation

プログラムのドキュメント

ユーザーにソフトウェアまたはプログラムを説明するテキスト、イラスト、またはビデオは、「プログラムまたはソフトウェアドキュメント」と呼ばれます。 ユーザーは、プログラマー、システムアナリスト、および管理者からエンドユーザーまで誰でもかまいません。 開発のさまざまな段階で、異なるユーザー用に複数のドキュメントを作成できます。 実際、*ソフトウェアのドキュメント*は、ソフトウェア開発プロセス全体で重要なプロセスです。

モジュール式プログラミングでは、ソフトウェアの異なるモジュールが異なるチームによって開発されるため、ドキュメントはさらに重要になります。 開発チーム以外の誰かがモジュールを理解したい場合、またはモジュールを理解する必要がある場合は、適切で詳細なドキュメントがタスクを容易にします。

これらは、ドキュメントを作成するためのいくつかのガイドラインです-

• ドキュメントは読者の観点からのものでなければなりません
• 文書は明確でなければなりません
• 繰り返しはありません
• 業界標準を使用する必要があります
• ドキュメントは常に更新する必要があります
• 期限切れの記録が期限切れになると、期限切れのドキュメントはすべて廃止されます

ドキュメンテーションの利点

これらは、プログラムのドキュメントを提供する利点の一部です-

• ソフトウェアまたはプログラムのすべての部分を追跡します
• メンテナンスが簡単
• 開発者以外のプログラマは、ソフトウェアのすべての側面を理解できます
• ソフトウェアの全体的な品質を向上させます
• ユーザートレーニングを支援します
• 知識の分散化を確実にし、人々が突然システムを離れた場合のコストと労力を削減します。

サンプル文書

ソフトウェアには、多くの種類のドキュメントを関連付けることができます。 重要なもののいくつかが含まれます-

• ユーザーマニュアル-エンドユーザーがソフトウェアのさまざまな機能を使用するための手順と手順について説明しています。
• 操作マニュアル-実行されているすべての操作とそれらの相互依存関係をリストして説明します。
• 設計ドキュメント-ソフトウェアの概要を示し、設計要素を詳細に説明します。 *データフロー図、エンティティ関係図*などの詳細を文書化します。
• 要件ドキュメント-システムのすべての要件のリストと要件の実行可能性の分析があります。 ユーザーケース、実際のシナリオなどを含めることができます。
• 技術文書-アルゴリズム、フローチャート、プログラムコード、機能モジュールなどの実際のプログラミングコンポーネントの文書です。
• テスト文書-テスト計画、テストケース、検証計画、検証計画、テスト結果などを記録します。 テストは、集中的なドキュメントを必要とするソフトウェア開発の1つのフェーズです。
• 既知のバグのリスト-すべてのソフトウェアにはバグやエラーがあり、それらは非常に遅く発見されたか無害であるか、修正に必要以上の労力と時間を要するため削除できません。 これらのバグはプログラムのドキュメントに記載されているため、後日削除される可能性があります。 また、バグがアクティブ化された場合、ユーザー、実装者、および保守担当者を支援します。