ドキュメントにジョブ設計やシステム構成を書くときがあるのですが、自信をもって書けてると思えません。
いつも句読点や受動態表現など悩みながら書いています。
そんな思いを持っているときに本屋を物色したら、このような本を見つけました。
- 作者:髙橋 慈子
- 出版社/メーカー: 翔泳社
- 発売日: 2018/11/19
- メディア: 単行本（ソフトカバー）
感想からいうととてもいい本でした！
技術者が書くドキュメントを読みやすくする工夫が豊富に書かれています。
「読みやすくするため」のせいか、本自体も読みやすく2,3時間程度で一気に読めてしまいました。
とはいえ中身は実用的なものばかりで、おーこれこれ！っといいたくなるコツが書かれています。
文を長くしない
ついついやっちゃうんです。
xxxはyyyなので、zzzというときにはaaaaaをします。
といったように理由→どうするを書く、つまり1文の中に理由などを詰め込もうとしてしまうんです。
これが良くない。文が長くなってわかりにくくなってしまいます。
1文は50文字までにすると読むほうもサラサラと読めるそうです。
「形容詞や名詞句ではなく動詞でズバリと書く」
BEFORE
会員登録が必要です。
↓
AFTER
会員登録をしてください。
「～をする必要があります。」
これ！もうねーつい書いてしまうんですよ！ほんとに。
手順書を書いたりするときにやらなければならない前提条件を書くことがあります。
読み直してみると～が必要と書いてあっても、じゃあそれをするにはどうすればいいんだよ！！っと自分のドキュメントにツッコミを入れたくなります。
具体的に指示を書くのがいいそうです。
「～などを多用しない」
これもよくやっちゃいます。対策としてはなどを省くか、例示したものの総称を書くのがいいそうです。
「ドライバーやレンチなど」→「ドライバーやレンチなどの工具」
～などをつける時ってだいたい自信のなさが根底にあるんですよね。
受動態と能動態を気を付ける
これもよく間違えます！！
日本語の悪いクセなのかわかりませんが、読む人のことを考えて受動態表現＝読む人への敬意と考えることが自分でもあります。
人の文章を読んでもあきらかにおかしいのに受動態表現が乱発してることがありますよね。
ユーザーがやる動作は能動態、起きる事象は受動態が基本だそうです。
アイコンがタップされるとアプリが起動し、ログイン画面を表示します。
↓
アイコンをタップします。アプリが起動し、ログイン画面が表示されます。
これで基準がわかるようになりました。
「話し言葉」と「書き言葉」を使い分ける
～してなくて → ～しておらず
とても → 非常に、大変に
～みたい → ～のようで
すみません → 申し訳ありません
別に書きたいように書く、また読む人が理解できればいいじゃん！！っと考えていた時期もありました。
でもね、そういう人の文章を読んでるとこいつ幼いな！、または知的に成長しないやつなんだな、っと思うようになってきました。
そういう文章を書く人の仕事は適当なんじゃないのか？っと連想されてしまうんですよ。
以前聞いたことがあるのですが、"大手企業の部長に企画書を見せたら「てにをは」しか直されず、年収2000万の人の仕事がこんなものなのかよ！"っというつぶやきがありました。
それに対して別の人が、"かなり大きな額が動くからそういう小さなミスにも気づかない人なんじゃないのか？っという連想を防ぐ意味もある"っと聞いてかなり納得してしまいました。
この本の中には他にも障害報告書の書き方例、ユーザーマニュアル、パワーポイントの書き方が記載されており、非常に勉強になるところが多くあります。
また冒頭の方で文章のロジックの重要性について章が割かれていました。
私はここも重要なところと考えています。
ここについては、以前読んだバーバラ・ミントの「考える技術・書く技術」がおすすめです。
合わせて読むと文章の書く力がより効果的に表れるでしょう。
- 作者:バーバラ ミント
- 出版社/メーカー: ダイヤモンド社
- 発売日: 1999/03/01
- メディア: 単行本
翔泳社様がRTしてくれてけっこううれしい。。
ご感想ありがとうございます😆特典🎁「単位記号の書き方」他をご用意していますので、よろしければ本と一緒にご活用ください
— 翔泳社の本 (@shoeisha_books) February 10, 2020
『 技術者のためのテクニカルライティング入門講座 』
高橋慈子 著
🎁詳細はこちら→ https://t.co/ZND7NgqnAb#翔泳社 https://t.co/3bKnnzfRdF
