ホーム > Blogトップ > Development > ドキュメントの話

ドキュメントの話

Posted on :| コメント (0) | トラックバック (0)

　ソフト開発とほぼセットになっているのが、ドキュメント。自分だけが使うならともかく、人様に使ってもらうソフトの場合、 ほぼ省略することは不可能。もちろん、ドキュメントなしで使えるのであれば、それに越したことはないが、 どうしても詰まったときにはドキュメントに頼らざるを得ない。

　ソフト開発の中で、ドキュメントのしめる割合は思った以上に高い。プロが作る場合は、仕様書をきちんと起こすし、 コンシューマー向けのソフトであれば、取扱説明書が不可欠になる。

　ドキュメントは設計・開発に利用する仕様書と、実際に運用する際に参考にする取扱説明書に分かれる。どちらも共通しているのは、 書くのが面倒なこと。
　シンプルぱっとを作っているときに感じていたのが、バージョンアップ時のドキュメント修正の手間である。 たいていはほとんどのエネルギーをバージョンアップで使い果たし、ドキュメントを修正できるだけの体力が残っていないことが多い。

　ドキュメントはソフトウェアと一緒にリリースされ、次のバージョンアップまでは修正されない。間違いに気づいたり、 ユーザーからの指摘で修正した場合、修正が反映されるのがずっと先になる。しかも、 ドキュメント修正を理由にバージョンアップされることはほとんどない。

　即座に修正でき、常に最新版に保つようにするにはオンライン上にドキュメントを公開することである。しかし、これにも欠点はあり、 常時接続環境でない場合や、紙に印刷したい場合には不都合が生じる。

　シンプルぱっと２のドキュメントをそろそろ用意しなければならない時期にさしかかり、どのような手段でこの問題を解決するか、 頭を悩ませているところである。おそらく、オンラインとオフライン両方のドキュメントを活用することになる。

　

トラックバック

このエントリーのトラックバックURL:

コメント

コメントフォームに記入し投稿してください





Search
最近の記事
カテゴリー
過去の記事
Comments
TrackBacks
Feed
Powered by