2009-06-26
■ [ruby][prog] リファレンスとドキュメントの話
反応をいただいた。
僕は説明書はとりあえず一通り目を通してみる方です(笑)。
が、メソッド単位の解説しかないという状態は、ケータイでいう「ぶ厚い方のマニュアル」しか入ってないようなものであり、 そんなもんをいきなりユーザに読ませるのは間違っていて、つまり我々が必要としているのは「ケータイ買ったときに入ってくるペラペラな方のマニュアル」 なのだな。
最近見た例だとerectorの公式サイトが、
SYNOPSYSSYNOPSIS- 「User Guide」
- RDoc
と3段階揃ってて良かったです。
ケータイは電話とメール読み書きしかできない情報弱者です><<br>erector 見てみましたが、なんかもう誰から見ても文句なさそうなくらい充実したドキュメント群ですね。cgi.rb の HtmlExtension に一言くらい触れたらどうかとは思った。<br>(さらにどうでもいいツッコミですが SYNOPSYS -> SYNOPSIS)