CuBeatSystems: ドキュメンテーションプロジェクト始めます (LCD Toolのドキュメントで感触を掴む)

2013年1月20日日曜日

プロジェクト進行の再考

昨年末から色々なプロジェクトの進行について再考していました。

現在もフォーカスを続けているプロジェクトを挙げると・・・

と小粒ながら、同様の問題で困っている人にはとてもよくわかるツール群を公開しています。

さて。

どのプロジェクトのウェブを御覧頂いてもわかるように、ドキュメントの品質たるや酷いものです。

そこで、2013年の注力事項の一つとしてドキュメンテーションプロジェクトを開始する事にしました。

どんなに素晴らしいツールを作っても、それが世の中で認知されなければユーザも増えません。

どんな課題があり、それをどのように解決するのか。

そして、副次的なメリットとしてどんな嬉しい事があるのか。

これらを適切に説明し、まずは使ってもらおうという事なのです。

いきなり全部のドキュメントを改良する事なんて現実的ではありません。

いずれのツールも最初に設計してから少し時間が経っているので見直したい箇所もあります。

そこで、手始めに何となく形になりそうなものから着手する事にしました。

ここ最近のツールの中でLCD Toolというユティリティがあります。

「LCDの画面表示ってドキュメントで作るの面倒だよねー。」という方の為に作ったツールです。

以下のような感じで第１バージョンを仕立ててみました。

まだまだざっくりですが、以前のドキュメントとは比べ物にならないくらい印象が変わりました。

新しい製品の場合、「使ってみようと思えるかどうか？」が第１ポイントのような気がしています。

あらためて「ドキュメントは重要」という認識。

もう「そうは言っても面倒」なんて言っている場合ではありません。

作業中のファイルのスナップショットをこちらからダウンロードできます。