ドキュメントの作成

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

 シンプルぱっと2正式版に向けたドキュメントの作成が終りました。 ドキュメント作成はソフト開発の中でも最もしんどい作業だと思います。特に、一般の人を対象にしたドキュメントは大変です。

 ドキュメント作成が大変になってきている背景として、競馬ソフトを使う人の裾野が広がったことがあげられます。 今までだったら配慮をしなくても良かった点を配慮する必要が出てきました(一言で言うなら全くの初心者が増大しました)。
 ただ、ドキュメントを細かく書いても読んでくれない事が多く、 これがサポートコストの増大につながっています(中には隅々まで読んでくれる人がいますが)。

 本当なら取説のいらないインターフェースを備えているソフトが理想ですが、自転車や包丁など機能が明確なものと異なり、 一般化が難しいソフトの世界では夢のまた夢です。もちろん、その中で分かりやすいインターフェースというのは常に考えていますが。

 質問の多い項目などはよくある質問としてまとめていますが、それでも似たような質問が絶えません(サポートコストの増大は、 開発作業に深刻な影響を与えます)。

 導入前に「○○できますか?」という質問も多く、この負担も多く、ドキュメント自体のあり方についても考えています。

 また、ヘルプコンパイラを通す前に、HTML HELPの構成を整えるソフトの使い勝手が悪く、 環境を移すとイチから再構築を強いられたり、 イメージやHTMLファイルが勝手に管理外の場所にコピーされるのも非常に苦痛です(最新版管理が破綻)。 ツールの入れ替えも検討しています。

 どのようなところでつまづくか、あるいは情報提示のあり方について一家言ある方は、コメントいただけると幸いです。

トラックバック

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

コメント

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





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