すべてのカテゴリ

プログラムのドキュメントの書き方プログラミングを仕事として行う場合、プログラミングのドキュメントは必須の物の一つです。趣味でプログラムを作るのとは違って、いろいろな人が作成するプログラムに関わってきます。作成するプログラムがどんな物なのかをプログラムを作った人以外の人が理解するのにドキュメントは重要です。どんなドキュメントが必要か？会社などでプログラムを開発する場合、沢山のドキュメントが作成されます。 基本的に、割り当てられた仕事毎に幾つか必要なドキュメントがあります。殆どの仕事には、「入力（インプット）」と「出力（アウトプット）」があります。 その仕事を進めるために必要な情報が「入力（インプット）」で、仕事の結果（成果）が「出力（アウトプット）」になります。プログラムを作る場合の入力は、「どんな機能が必要か」が入力（インプット）になります。この入力の情報に基づいて「どんなプログラム」を作るかが、プログラムを設計する人の出力（アウトプット）になります。多くの場合、仕事と仕事を繋げる役割をするのが、ドキュメントになります。従って、一つのプログラムの開発プロジェクトの場合でも、沢山のドキュメントが必要になります。＊　利用者の要望、意見、フィードバックをまとめたもの＊　実際のプログラムの要求をまとめた物＊　実際のプログラムで実現する機能や方法（やり方）をまとめたもの＊　プログラムの使い方をまとめた物＊　プログラムのテストの方針をまとめた物（テストプラン）＊　プログラムのテスト結果をまとめた物（テストレポート）など基本的なものだけでも結構な数になります。当然ですが、作成するドキュメント