« リリース前不具合修正 その5 | トップページ | UNIXで自己解凍 »

2015年4月20日 (月)

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

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

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

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

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

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

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

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

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

« リリース前不具合修正 その5 | トップページ | UNIXで自己解凍 »

コメント

コメントを書く

コメントは記事投稿者が公開するまで表示されません。

(ウェブ上には掲載しません)

トラックバック

この記事のトラックバックURL:
http://app.f.cocolog-nifty.com/t/trackback/2011805/59711676

この記事へのトラックバック一覧です: リリースに向けてマニュアルを書かなくてはならない…:

« リリース前不具合修正 その5 | トップページ | UNIXで自己解凍 »