技術者のためのテクニカルライティング
https://gyazo.com/925a009b4e8b4f7e2063a9e312dfe358
全体的に、もう一冊のテクニカルライティングの本と、ヘルプサイト〜の本に書いていることが多数。目新しい理論は無いように感じた。行頭記号やフォントの利用など、視覚的な話が少しあったくらいか。
この本自体が、プレゼン資料、報告書、マニュアルなど多岐にわたる文書を対象にしているので、例は豊富。前半は、さまざまな事例の中で使える汎用的な手法を取り扱っている。後半は実践編として、それぞれの文書ごとBeforeAfterを例示しながらテクニカルライティングスキルについて深ぼっている。
個人的には各論にあまり興味持てなかったので前半を中心に読んでメモしておく。
行動につながるよう動詞を使って書く
状況説明でなく、行動につながるように動詞を使って書くことを意識しましょう。
婉曲な表現としてよく見られるのが、「〜が必要です」という文です。〜中略 書き言葉で、かつ作業や操作をしてもらうことが目的ならば、「〜してください」の文は失礼に当たりません。何をすべきかが明確に伝わる、読み手に親切な文だと言えるでしょう。
読み手がすべきことは能動態、結果は受動態で書く
丸かっこと鍵かっこを使い分ける
丸かっこ内で補足説明をしない
丸かっこは語句の言い換えや品番、製品名を書くときに使う
階層構造をうまくつかう
階層は3階層まで
プレゼンは2階層まで
行頭記号は黒い面積が大きいものから階層が上(知らなかった!)
■ → ● → ・
箇条書きは見出しをつけてまとめる
文章の中に箇条書きをまぜない
手順書の書き方
タスクを整理して記述する
ステップは10個まで
操作と結果を分けて書く
作業の概要を必要な情報に絞って書く
この作業はなにか、そのように使い、メリットはなにか、をわかりやすく伝えるのが概要
参考情報は種類に分けて見出しをつける
例)■MEMO、■使い方のヒント、■知識
注意文は最初に書く
障害報告書の書き方
概要と事実を分けて書く
事実、原因、対処の順に書く
原因はわかりやすく、専門用語を多用せずに書く
メールの書き方
重要な内容、相手にしてほしいことを最初に書く
5W1Hまたは5W2Hを意識する
When, Where, Who, Why, What, How, Howmuch