PHPソフトウェア開発ドキュメントの書き方

PHP ソフトウェア開発ドキュメントの書き方?

1タイトル
ソフトウェア システム名と識別子
モジュール名と識別子 (このドシエに複数のモジュールが含まれている場合は、モジュール名の代わりにこのモジュール グループの関数識別子を使用します)
プログラマーの署名
ドシエの変更されたテキストのシリアル番号
変更完了日
Dossier シリアル番号 (Dossier 全体の中でのこの Dossier のシリアル番号を示します)
手配日 (Dossier 全体の最新の手配日を示します)

2 モジュール開発状況表

3 関数の説明
このモジュール (またはこのモジュールのグループ) の機能、主に入力、リクエスト処理、出力を簡単に説明します。システム設計仕様書から抜粋できます。また、ソフトウェア要件仕様書のこれらの機能を説明する章、条項、および条項もリストします。
4 設計の説明
このモジュール (またはこのモジュールのグループ) の設計上の考慮事項について説明します。次の内容が含まれます。
a.システム設計仕様書におけるこのモジュール (またはこのモジュールのグループ) の設計上の考慮事項の説明 (ソフトウェア システムにおけるこのモジュールのレベルおよび他のモジュールとのインターフェイスを含む);
b.プログラミング命令におけるこのモジュール (またはこのグループのモジュール) の設計上の考慮事項には、アルゴリズム、処理フロー、関連するデータ ファイル設計の制限、このモジュールの駆動方法およびエラー メッセージが含まれます。すべてのテストに合格したソース コードをコンパイルするときに実際に使用された設計上の考慮事項。

5元のコード リスト生成されたこのモジュール (またはこのモジュール グループ) の構文エラーのない最初のソース コード リストと、すべてのテストに合格した現在有効なソース コードを指定する必要があります。リストアップ。

6テストの説明このモジュール (またはこのモジュールのグループ) を直接通過する各テストについて説明します。これには、これらのテストのそれぞれの識別子と番号、これらのテストの目的、および方法が含まれます。構成と入力、期待される出力と実際の出力。

7 レビューの結論実際のテスト結果と、ソフトウェア要求仕様書、システム設計仕様書、プログラム設計仕様書に規定されている要件を比較し、結論を出します。

以上がPHPソフトウェア開発ドキュメントの書き方の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。