自作ソフトウェアのドキュメントを書こうと思っています。わかりやすいドキュメントを書く際に気をつけるべきこととしてはどんな物があるでしょうか？

Question

125

200pt

回答の条件

※ 有料アンケート・ポイント付き質問機能は2023年2月28日に終了しました。

コメントはまだありません

「あの人に答えてほしい」「この質問はあの人が答えられそう」というときに、回答リクエストを送ってみてましょう。

これ以上回答リクエストを送信することはできません。制限について

回答リクエストを送信したユーザーはいません

Answer 1

■ 画面イメージ

viba2006/07/04 23:10:03

1pt

やっぱりどんなドキュメントでも多くの画面イメージを

用い説明をしたほうがわかりやすいですよね

特に不特定多数に配布する場合、くだらない質問が来ても

困るので、それを防ぐためにも極力シロートに

わかりやすいようにするのがよいでしょう。

他の方の意見で、索引が必要とありますが

HTMLで作成することにより作成の手間は結構省けますし

オンラインマニュアルにすれば更新も楽です。

また、更新履歴などは上級者が必要としているため

TEXTなどで簡潔に表現することで十分でしょう

回答（11件）