哲学的な話になりますがドキュメントを書く上で「わかりやすさ」を増すにはどういった記述にすればいいでしょうか?

例:図や表を駆使する
その他ありましたら教えてください。
よろしくお願いいたします。

回答の条件
  • 1人2回まで
  • 登録:2007/10/11 22:06:17
  • 終了:2007/10/18 22:10:03

回答(9件)

id:KUROX No.1

KUROX回答回数3542ベストアンサー獲得回数1402007/10/11 22:13:17

ポイント17pt

■文章の「わかりやすさ」と「正確さ」

http://www.yamanouchi-yri.com/yrihp/techwrt-2-5p/t-2-5abs01f.htm

一文一文を短めにかくとかですかね。

id:hanatomi No.2

hanatomi回答回数853ベストアンサー獲得回数362007/10/11 22:26:03

ポイント17pt

いわしで同様のしつもんがありました。

http://q.hatena.ne.jp/1152010327

わかりやすいドキュメントを書くのに必要な事


又、ここにも和訳したものが載っています。

http://peace-pipe.blogspot.com/2007/10/arch.html

ドキュメントを書くのに必要な事

id:nihonnihon No.3

nihonnihon回答回数43ベストアンサー獲得回数02007/10/11 22:48:00

ポイント16pt

カタカナ語を極力使わない。

「ドキュメント」のような、「誰でも分かるだろう」と思われる物も含め、極力使わないようにする。

使うのは「テレビ」「パソコン」のような、カタカナ語以外にするとかえって難しくなるもののみにする。

id:sinsuke3 No.4

sinsuke3回答回数482ベストアンサー獲得回数252007/10/11 23:14:19

ポイント16pt

分かりやすい日本語文章の書き方

http://homepage3.nifty.com/skis/hp_jp/japanes_1.htm

id:errormap No.5

errormap回答回数100ベストアンサー獲得回数22007/10/11 23:35:04

ポイント16pt

成功例と難しさから一歩引いた失敗例をあげると他人を引き込みやすいのではないでしょうか?

PC業界関連のそういった著作が幾つか見受けられます

基本的な事だけどそれを出来ないレベルの人ってけっこういます。

でもレベルの高い人にひっぱられてそこにふれる機会はわりと少ないです。

他人の失敗例なんかを見て人はけっこう自分を見直す機会を得たりするものじゃないでしょうか?

そういった意味で第三者を引き込む力があると思います。

id:virtual No.6

virtual回答回数1139ベストアンサー獲得回数1282007/10/12 07:12:58

ポイント16pt

「ドキュメント」というのは「何かを説明する文章」のイメージで捉えていいでしょうか?その前提で回答します。

まず「ドキュメント」の読者が誰なのかを明確にする事です。そして一定の知識が読者に求められているのであればそれをドキュメントの先頭にそれを宣言するのです。

また、その読者が「分からない」「知らない」言葉は使わずに説明します。あるいはそういった言葉が必要であればその言葉の意味をドキュメントの中で定義してあげます。

というようなことが出来ていないドキュメントはたとえ想定された読者として呼んでも理解するのに苦労することが多いです。

id:Sag_Chicken No.7

Sag_Chicken回答回数211ベストアンサー獲得回数42007/10/12 12:55:01

ポイント16pt

ドキュメントの表現を哲学で語るんですか?・・・難しいな。

話し言葉をそのまま書くと主語がなくなることが多いですね。

話の流れから明確にわかる場合はいいのですが、読んでいる人が分かりやすい程度には主語を入れる。

長い文になることは避ける。修飾をつけすぎないようにする。

 

すみません。ぜんぜん哲学的ではない感じがしてきた。

id:ardarim No.8

ardarim回答回数897ベストアンサー獲得回数1452007/10/13 18:20:31

ポイント16pt

ひとりよがりにならないことが大事だと思います。

客観的にわかりやすい文章であること。


自分が「常識」と思っていることが他人から見ると???なこともあります。自分が門外漢の第三者になったつもりで用語や説明を見直してみてください。その中で図表を使ってわかりやすくするのも重要です。


また仕事と直接関係ない人を呼んでレビューしてもらうのが良いでしょう。(例えばソフトのドキュメントならハードの人に見てもらう。製品の取扱説明書のようなものなら、製品と全く関係ない人に見てもらう)


あと基本中の基本ですが、同音異義語の間違いは注意しましょう。漢字変換で打っていると気付かずに残ってしまうことがありますが、後で見るとみっともないし、前後のつながりがないので意味が全くわからなくなることもあります。

質問者が未読の回答一覧

 回答者回答受取ベストアンサー回答時間
1 suicadayo 39 32 1 2007-10-15 23:48:48

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

この質問への反応(ブックマークコメント)

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

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

絞り込み :
はてなココの「ともだち」を表示します。
回答リクエストを送信したユーザーはいません