chapter1.adoc

1.1 はじめに

携帯電話の取扱説明書からソフトウェアのマニュアルまで、製品をつくる際にはドキュメント（文書）作成は避けてとおれません。さらに製品の説明書やマニュアル以外にもドキュメントと呼べるものが多数存在します。仕様書や社内で利用しているWiki、本書のような技術書籍などもドキュメントといえます。以下、一般的なドキュメントの一覧です。

• 論文

• 仕様書

• 取扱説明書

• 技術書籍

• 製品マニュアル

  • FAQ、トラブルシューティング、クィックスタート

• 企画

• 報告書

• 特許

• 白書

• 要件定義書

• Wiki

• 技術書籍

上記のように多様なドキュメントが存在しますが、ドキュメントが作成される目的はおなじです。ドキュメントが作成される目的は、読者に記述内容を早く正確につたえるという点に集約されます。

…​

1.2 ドキュメントの品質

上記のような問題を回避する手段として、ドキュメントの品質を高める必要性は広く認識されています。

…​

1.3 オープンソース化するドキュメント

オープンソースのライブラリやツールのマニュアル（ドキュメント）をプロジェクトの一部として公開、開発する事例が増えています。さらに最近では、ドキュメント自体をオープンソースプロジェクトとして公開する事例も見られるようになっています。

たとえばコンピュータ言語について学べる書籍（ドキュメント）がすでにGitHub上で公開されています。これらのドキュメントはWeb上のドキュメントとはいえ手軽にHTMLやEPUBなどのフォーマットに変換できます。オープンソース書籍は手持ちのリーダでいつでも読めるため、通常の電子書籍と同様、手軽に利用できます。

Note	GitHubはバージョン管理システムGitのホスティングサービスです。[chap4]で解説します。

たとえば図1.1（[レイツ]）はPythonについて書かれた電子書籍です。

図1.1 電子書籍：Hitchhiker’s Guide to Python

…​