ドキュメンテーション 【documentation】 文書化 / ドキュメント化
概要
ドキュメンテーション（documentation）とは、ある事柄に関するデータや情報、記録などを、他の人が理解しやすい形式の文書として体系立ててまとめること。また、そのようにしてまとめられた文書群。ITの分野では、装置やソフトウェア、システムなどの仕様や構造、設計、使い方、注意点などを体系的に文書としてまとめることを意味する場合が多い。マニュアルや取扱説明書のように製品の利用者に使い方などを説明するために行われる場合と、仕様書や設計書のように他の開発者に設計情報などを伝達・共有するために行われる場合がある。
コンピュータプログラムの場合、プログラミング言語で書かれたソースコード中に注釈を記述できる「コメント」機能を用いて、コードの中に関数の引数や返り値の説明などを直に記述する形でドキュメンテーションを行う場合も多い。Javadocのように、コメントに一定の書式で説明を記述すると見やすく整形して出力してくれる仕組みが用意されている場合もある。
(2020.6.30更新)
共有ボタンをタップ