BitArts Blog

ロードバイク通勤のRubyプログラマで伊豆ダイバー。の個人的なブログ。

マニュアル執筆

ドキュメントの充実していないシステムなんてけしからん!!と言われようが、僕のポリシーはマニュアルなど読まなくても直感で使えるアプリケーションを設計することであり、仕様書など読まなくても容易に読み下せるプログラムを書くことなのだ。そんなのプロなら当然だろ。ドキュメントのニーズが発生するなどダメなアプリケーションの証拠だ。

というイイワケをしてもしかたない。よく知られているように基本的にプログラマというのはドキュメントという言葉が嫌いな種族なのである。プログラミングも文書作成も、どちらもキーボードを使った創作活動に変わりないはずなんだけど、なぜかドキュメントは嫌い。不思議。バリバリ作って調子に乗ってくるとプログラミング以外の部分にエネルギーを割きたくなくなるんだよね。ユーザーであろうが他人のためにドキュメント書くなんて論外。

言い訳は以上。というわけで、まじすいませんでした。本当に遅くなってごめんなさい。EagleRay CMSは次回のリリースで遂にマニュアル(オンラインヘルプ)が搭載されます。最初のリリースから3年、いつのまにか300社ほどに導入され、さすがにヤバい感じがしてきたので、やっとようやくの公式マニュアル。(今までは販売店様に1から作ってもらってました、すいません)

せっかく便利な機能を載せているのに、知られておらず有効に使われていなかったところも多いようなので…最低限の説明書はやっぱ必要ですね。(;^ω^)

現在必至で執筆しています。来月中にリリース予定です。

コメント

2008/10/24 07:16 from はせ

>いつのまにか300社ほどに導入され

うーん、こういうのを聞くとやっぱり宮前ってすごいのかなーとか思うけど、やっぱり気のせいって気もするし。どっちなんだろう。

2008/10/24 09:53 from ゆりか

ドキュメントをいっさい作らないまま1日1万以上のページビューがあるWebシステムを構築した方のためにここ2か月くらい、毎日ドキュメント書いてます。
もちろんこの作業は大嫌いです。
UML苦手〜

2008/10/27 10:34 from 美少女まさや

「せっかく便利な機能を載せているのに、知られておらず有効に使われていなかった・・・」じゃ、ソースコード=ドキュメントのオープンソース見たいじゃん。

ちなみに仕様書は・・・崇拝に価するデザイナーが書いた仕様書はもはや経典であるとおもう。