ドキュメント

2007/10/28

この土日は特にすることもなかったから、「主筆」のマニュアルの作成に費やした。おかげで日本語版マニュアルとプラグイン開発ガイドの第19版をあらかた準備し終えた。

内容の最新化は当然だが、それ以外にも一部デザインの変更や日本語の見直しを行った。また、今までは目次は手作業で作成していたのだが、ちゃんと書式を設定して自動で振られるようにした。今後の作業の軽減を考えてのことだ。

表紙のデザインは相変わらず右上に主筆のネェちゃんを配置したもののままだが、表題のフォントだけ変えておいた。何となく、プロポーショナルフォントの方がしまりがあって良さそうだったからだ。

残るは英語版のマニュアルだけである。書くべきことは日本語版のものにすべて記載されているのだから、それを英語に訳していけばいいだけなのだが、この作業が非常につらい。おまけに時間がかかる。

自由に英文の読み書きができればいいのだが、なかなかそうもいかず、毎回苦労している。それなのに、日本語版マニュアルの作成以上に全く持って報いられることはない。この正真正銘の無駄な作業は、やめるべきか続けるべきか。難しいところだ。



それと、全然関係ないことだが、さっきから文字を入力していると画面下部にある「今すぐ保存」がどんどん右に伸びていく。いったい何が起きているのだろうか。

妥協

2007/10/25

最近ようやく、「主筆」の印刷機能の実装が終わった。 本当であれば、まだいろいろな機能を付けたいと思っているのだが、いつまでやっていてもきりがないので、基本的な機能が通り一辺できたところで第19版として公開することにした。

後は例のごとくドキュメントを整備するだけである。毎度のことながらこれが辛いのだが。

しかし問題はどこまで詳細に書くか、という事である。印刷機能が増えたと言うことで、最低でも印刷の仕方だけ記載すれば、それで事足りるはずである。だが、ドキュメントの品質を考えた場合は、より詳細なトラブルシュートや構成変更についても記述するべきである。

しかし当然ながら、細かく書こうと思えば思うほど泥沼にはまり、いつまで経っても公表できなくなることになる。その上、英文ドキュメントも作成しなければならないことを考えれば、ある程度のどころで妥協するのは必要欠くべからざることである。

それに、「プラグイン開発者ガイド」の英文を用意するか否かという問題もある。ページ数が多いから今までこの問題には手を付けないできていたのだが、そろそろ本気で考えても良いかも知れないと思っている。まぁ、多分作らないだろうけど。