ドキュメントの構造化による、良いドキュメントの作成方法 | gihyo.jp

あけましておめでとうございます。 ソフトウェアを開発し公開する場合、ドキュメント（マニュアル）を作成することが求められます。しかし、良いドキュメントを作成する方法というのはあまり知られていません。どのようにすれば良いドキュメントを作成できるのでしょうか？ 本稿では、ソフトウェアと同じくドキュメントを要素と性質に構造化することで、良いドキュメントを作成する方法を紹介します。そして、その要素と性質に対してアプローチを行っているESDocというJavaScript（ECMAScript2015）向けのドキュメンテーションツールについても簡単に紹介します。 対象とするドキュメント ドキュメントと一口にいっても仕様書、設計書、マニュアルなど様々な種類が存在します。そこで、本稿が対象とするドキュメントを「ライブラリやフレームワークなどを開発するソフトウェア開発者自身が、そのソフトウェアの使い方をエンド

[sett-4]

ドキュメントの構造化による，良いドキュメントの作成方法

[highfrontier]

ci, develop, doxygen, test ドキュメントの構造化による，良いドキュメントの作成方法

[kgrock]

ドキュメントの構造化による，良いドキュメントの作成方法

[kkeisuke]

ESDoc

[minonet]

ドキュメントの構造化による，良いドキュメントの作成方法 ── 新春特別企画 本稿では，ソフトウェアと同じくドキュメントを要素と性質に構造化することで，良いドキュメントを作成する方法を紹介します。