タグ

ドキュメンテーションとdocに関するkyo_agoのブックマーク (1)

  • ソフトウェアドキュメンテーション - Wikipedia

    設計文書は様々な形式がある。どのように(HOW)使うのかよりも、なぜ(WHY)そのように設計されているかを解説することに注力していることが多い。例えば、データ構造がそのようになっている背景となる原理を解説したり、特定オブジェクトのメンバー関数をリストアップしたり、コードの追加方法を記述したりする。あるクラスがなぜそのように構成されているかを説明し、パターンを示し、よりよい方法の概略を提案したり、今後の改善を提案したりする。これらは、コードに関する文書やユーザー向け文書には不適切だが、設計にとっては重要である。 アーキテクチャ文書は設計文書の特殊例である。ある意味で、アーキテクチャ文書はコードからの第3の生成物(第1はコードに関する文書、第2は設計文書)である。アーキテクチャ文書にはコードに固有な部分はほとんどない。特定のルーチンのプログラム方法を説明することはほとんどなく、あるルーチンがな

  • 1