リリースに向けてマニュアルを書かなくてはならない…

今のところβバージョン扱いなので、手抜きなReadMe.txtで誤魔化しているのですが、やはり最終的にはもう少しマシなドキュメントを作らなければならないのでしょう。

今あるReadMe.txtをベースにしようとは思っているのですが、どういう形で用意しようかと漠然と考えてはいたのですが、イマイチモチベーションが上がりません(*^-^)

LibreOfficeのWriterで、WYSIWYGな環境で書くのがいいかなぁと思ったりもしたのですが、今後のメンテナンスを考えるとこの手のアプリケーションを使うのはあまり効率よくなさそうな気もしていました。

で、先月号の「Software Design」を眺めていて、Sphinxというドキュメンテーションツールが紹介されていたのが目に止まりました。

このツールはWordのようなWYSIWYGなツールではなく、TeXのようにテキストファイルで記述して、いろいろなフォーマットの文書ファイルに変換できるそうです。例えば、html, PDF, EPUBなどなどに変換できるみたいです。

現在同梱している、人が読める形の通常のテキストフォーマットのReadMe.txtをベースにreStructuredTextというマークアップ言語に書きなおして、図とかを追加してやれば、なんとなく行けそうな気がします。

Sphinxの日本ユーザ会 (Sphinx-Users.jp) のページ

新しいことを勉強しながら書くほうがなんとなくモチベーション上がりそうですし…