「技術者の為のテクニカルライティング」と聞いたら、なんだか難しい技術書籍の書き方か、プログラムソースのコメントか、設計や仕様ドキュメントなのかな〜と思って手に取った書籍です。
読んでみたらビッくらポンの内容だったので、ブログにレビューを載せておきたいと思います。
レビュー
★★☆☆☆
技術者というよりは、SEなどの要件定義などの資料作成や、クライアントとのやりとりメールなどのドキュメントの書き方指南の書籍でした。
エンジニアとしての自分には、アンマッチな内容だったので、評価は低いですが、営業寄りのフリーランスエンジニアやこれからエンジニアエージェントを始める的な人であれば、マッチすると思います。
ていうか、メールの書き方やテンプレートって、新入社員の研修内容的なレベルに正直無料冊子を読んでいるのかと勘違いしてしまったんですよ。
この書籍から学べるポイント
文章長くなりがち問題
1つの文章が長くなりすぎるのは、良くないとされています。
接続詞で数珠繋ぎに繋いだ文章は、全く何が言いたいのかわかりません。
ブログも似たようなものですが、なるべく簡潔に箇条書きに近い状態での文章がいいとされているようですね。
自分視点問題
日記や読書感想文は、自分視点で書くものですが、
技術ドキュメントは、第三者視点で書く必要があります。
読み手は、目の前にいる人だけという視点で書くと、それ以外の人が見るとまるで何を書いているのかわからない文章になりがちです。
「技術者以外の人が読んだとしたら・・・」ということを頭に置いて書くようにすると、結果として読みやすい文章になることが多いでようですね。
ロジカルとテクニカルなライティング技術
いきなり描き始めてはいけない5つの理由
1. 説明の順番がおかしくなる
2. 何度も繰り返しの説明で、ダブりが生じる
3. 必要な情報が抜ける
4. 書き上がるまでに時間がかかる
5. 筋道が通っていないため、お見手が理解しにくくなる
事前に情報を整理してロジックツリーを組み立てていくことが必要です。
「文、文章、文書」はどう違う？
「文」とは、文字が連なった1つのまとまり。
「文章」とは、ある意味や内容のまとまりを文字で表したもの。複数の文から構成される。
「文書」とは、ある目的を持って情報を記録したものの総称。図や写真なども含まれることがあります。
冗長な文は、英語に翻訳してもわかりにくい
わかりにくい日本語は、英語にも翻訳しづらいし、翻訳しても意味が伝わりにくいものです。
逆に、わかりやすい日本語は、英語に翻訳しやすく、英語でも意味が伝わりやすくなるというものですね。
英語の学習をしている人は、日本語力を上げることも英語学習につながるというふうに考えるといいですね。
二重否定にしない
1つの文章で否定表現が2つある文を「二重否定」と言います。
「〜しないと〜ない」というような言い方を普段からしている人は自分が気が付かないうちに相手に伝わりにくい表現が当たり前になっている可能性があります。
否定の否定は肯定になるような気もしますが、次のような文章をどう思います？
「今日は晴れないと、洗濯物が干せない」
同じ意味で
「今日は晴れたら、洗濯物が干せる」
と言った方がより伝わりやすい感じがわかります？
「〜なくなくない？」という三重否定になると、もはや現代語の若者言葉っぽくなりますが、聞き手の頭の中は、行ったり来たりになっているでしょう。
文章のレビューチェックリスト
あとがき
文章の書き方は、読み手への伝える技術です。
人に伝える技術というのは、知らないよりも知っておいた方が確実にいいんです。
でも、この本を読まなくても、世の中にはたくさんの伝達技術を説明してくれる場があるので、この本でしか身につかないということはないな〜と読み終わった後に思ってしまいました。
紹介したこの本のポイントは、前半部分に書かれている内容で、後半は、
マニュアル、提案書、報告書、メールの書き方という、かなり初歩的な内容になっています。
最終章にAIプロンプトの書き方という、今時のAI初心者の人向けの内容になっており、全体を通して、新社会人向けの内容であると感じました。
文章に自信がないという人は、読んでみると、学びが多いかもしれませんよ。
0 件のコメント:
コメントを投稿