TOP > ブログ > プログラマではない人によるドキュメント(ヘルプ)の使い方

プログラマではない人によるドキュメント(ヘルプ)の使い方

2006/12/12

「How non-programmers use documentation」という記事がありました。 面白かったので一部を訳してみました。 間違いなどがある可能性があるので、詳細は原文をご参照下さい。

この記事は、プログラマではない人がどのようにドキュメントを参照するかをまとめています。 これを参考にして、ユーザフレンドリーなドキュメンテーションを作ってくださいと書いてありました。

Internal and on-line

1. プログラマでない人は、オンラインヘルプはアプリケーションと一緒に提供されるべきだと考えている。
2. プログラマではない人は、オンラインヘルプ中にスクリーンショットを欲する。 それにより、ファイルサイズが大きくなる事は全く気にしない。
3. プログラマではない人は、オンラインヘルプをクイックリファレンスとして利用する。そのため、目次と検索機能は重要である。
4. プログラマではない人は、アプリケーションの一部としてヘルプが提供されていれば、それを一通り見る。
5. プログラマではない人は「Tips and Tricks」ダイアログボックスがあれば、それを見る。
6. プログラマではない人は、印刷されたマニュアルを読まない。
7. プログラマではない人は、アプリケーションに関する本は買わない。彼らは技術書はプログラマのものだという。 (訳注：あまりそうは思えませんが。。。)

Simple

1. プログラマではない人は、詳細を求めてはいない。彼らが欲しいのは簡潔な回答だ。
2. プログラマではない人は、詳細すぎる情報は好きではない。
3. プログラマではない人は、簡潔で、順を追った(step by step)説明を好む。
4. プログラマではない人は、「どうやったら○○できる」と言った回答を好む。
5. プログラマではない人は、機能がどのようにして実装されているかは知りたくない。

Complete, Correct and update

1. プログラマではない人は、アプリケーションとともにオンラインヘルプが最新に保たれている事を期待している。
2. プログラマではない人は、オンラインヘルプの一部が欠落していると、オンラインヘルプを全く見なくなる。
3. プログラマではない人は、オンラインヘルプで問題が解決できないときにはコールセンターに電話をするか、違うアプリケーションを使ってしまう。
4. プログラマではない人は、ソフトウェア開発会社にバグレポートを送ったりはしない。 プログラマに情報を送ってあげるという発想は微塵も無い。

最近のエントリ

過去記事

過去記事一覧

IPv6基礎検定

YouTubeチャンネルやってます！