マニュアル執筆中(その28)

今日はSI2014の予稿原稿の締め切りです。
なので、おそらく来週から続々と作品投稿されることになると思います。
正直なところ1人ぐらい先走る人がいるかと思ったのですが皆さん慎重ですね。

そういえば、さっき予稿原稿の締め切りを知らせるメールが来ました。
その中で9月30日までにRTミドルウェアコンテストサイトへの参加登録(ログインしているとこのページの下のフォームからできる登録です)もしてくださいということも書いてあってので、僕以外にも勘違いした人がいたみたいです。ちょっと安心しました。なんでだよ


マニュアルにApache OpenOffice 4.1.1でのインストール方法を追記しました。
ただし、OpenRTM-aist-Pythonのインストールに手間がかかるため推奨しません。


それからUbuntu-14.04LTSでLibreOfficeの対応しているPythonのバージョンを調べたところ3.4だったので使用できないことがわかりました。
一応LibreOfficeの対応しているPythonのバージョンを変更する方法もあるとかないとからしいのですが、こちらで実験するだけならともかくダウンロード先でそれを強いるのはさすがに無理があるのでLibreOiffce4.0以降がインストールされているUbuntu13.04～14.04のサポートはしないことにします。
OpenRTM-aist-PythonがPython3に対応するのを待つしかないようです。




今日もコメントなし。
どうにもRTMのメーリングリストとか見てると「ググレカス」とか「普通に考えればわかるだろ」とか言う人は全くと言っていいほどいません。前に一人だけ見たことがあるぐらいです。
それは凄く良いことなのですが、どうもそのことがコメントが全く付かない原因になっているような気がします。僕は苦情でも悪口でもとにかく質を問わずコメントが欲しいのですが、そんなこと書く人がそもそもいないみたいです。ちなみに僕は人の非難をすることが目的になっているような人間は大嫌いです。他の候補者の批判ばかりしている政治家は信用できません。それにもかかわらず苦情や悪口でも欲しいというのは相当卑屈になっているからです。

とりあえずコメントにこだわるのはやめて、プロジェクトページ上部のいいねボタンが20回以上押されることを目標にしようかな。



これからはマニュアルに力をいれます。
RTMコンテスト2010のRTC-scilabのマニュアルがコメント欄で良く書けてるとか評価されてたのでとりあえずこれを熟読してみた。
何というかマニュアルの質も良いのですが、ソフトウェア自体が段違いのクオリティだなあ。
このレベルの作品を今年出されたら100％勝ち目がありません。現に当時も全く手も足も出なかったので。




マニュアルの全体の流れとして、

1. 概要
2. インストールの方法
3. 使う前の準備(ネームサービスの起動等)
4. 動作確認
5. 簡単なデモ
6. 高度なデモ
7. トラブルシューティング

やっぱりマニュアルはこのぐらいの長さでないと読む気が起きません。
というよりどのソフトウェアでもはマニュアルを読まなくても使用できるのが理想形なのであって、ちょっと試用したいだけなのに長いマニュアルを読まなくてはいけないソフトウェアはなかなか評価しづらいです。




このマニュアルと比較して自分のマニュアルは何が足りないかを考えてみます。
チュートリアルが動作確認を兼ねているつもりなのですが、ちょっと不親切かもしれません。
インストール後チュートリアルに誘導するように加筆しておきます。
それからチュートリアルで簡単な動作しかしていないことが前々から問題だと思っていました。もっと具体的なシステムの例があれば用途がわかりやすいのですが、なかなかアイデアがありません。
トラブルシューティングもとりあえず書いておきます。









にほんブログ村のロボットのカテゴリから
全然人が来ない・・・