Sphinxのドキュメントサンプル：業務利用例¶

日本UNIXユーザ会 2010年12月勉強会 (2010/12/3) の発表で使用したドキュメントを作りたくなってしまう魔法のツール Sphinx のデモで使用したドキュメントのひな形です。プレゼンテーションの全文は ドキュメントを作りたくなってしまう魔法のツール Sphinx にあります。

デモで使用したSphinxのドキュメントサンプルを以下のリンクからダウンロード出来ます。

Step1 Sphinxの初期ドキュメントから始める¶

初期ドキュメントから始めると言っても、 sphinx-quickstart コマンドで作成しただけの状態のファイルを共有しても、それではドキュメントを書いてくれないでしょう。これは「どう書いて良いか分からない」を解消していません。

前述の、読者のターゲット別に章節の構成をおおまかに用意します。この段階でドキュメントの大枠は用意できました。そして、いつでもドキュメントを作成、変更、HTML出力まで動作するようになりました。しかしもう一歩踏み込んで、既に分かっている情報を書いてしまいましょう。

マネージャー、設計者、開発者それぞれに必要となる情報を用意します。ここまでの情報がそろっていれば、プロジェクト開始時にメンバーに情報が行き渡らないということはあまりなくなると思います。

段階的にドキュメントに記載していくことで、ドキュメントが成長していきます。記載していく途中途中で、章の構成もどんどん変わっていってかまいません。