🕶️

『読み手につたわる文章 テクニカルライティング』を読んだ

2024/12/06に公開

読んだ本

mochikoAsTechさん著の『読み手につたわる文章 - テクニカルライティング』を読みました!

https://mochikoastech.booth.pm/items/5703302

こちらは2024年5月に開催された技術書典で購入しました(オンライン購入)。積読していたものをこのタイミングでやっと読みました。

本の詳細

「自分の書いた文章や文書が『わかりにくい』気がするが、どこがどうわかりにくいのかがいまいちわからない」という方に、特におすすめだなと思います。

「わかりにくい」の理由が説明されている

「この点に気をつけましょう」というポイントともに「なぜそのポイントが大事なのか」という点が丁寧に説明されています。

例えば、「2.2.3 既知から未知に繋ごう」という項目があります。読み手が知っていることから始めて、だんだんと知らないことに繋げていきましょう、という内容です。ここでは「既知から未知の順で書くことの良さ」が「未知から書いた場合の困りごと」の説明によって表現されています。

なにがわかりにくいのか、を理解できていない状態で言われるがまま修正してしまった場合、モヤモヤした感情のみが残ってしまいます。さらに、次回も同じような指摘を受けてしまうでしょう。

このようにこの本では「わかりにくい」の理由が丁寧に説明されています。納得感を持って、より良い文章を書くポイントを押さえられると思います。

幅広くポイントが押さえられている

文章レベルのポイントから、文書を構築する上でのポイント(文書構造など)まで幅広く触れられています。さらに、翻訳や文書のレビューに関しても触れられています。

特に文書のレビューに関しては、ソースコードレビューにも活かせる内容だと感じました。レビュアー(レビューする側)とレビュイー(レビューされる側)、それぞれについて書かれています。自分がレビュイーばかりだとしても、両方を読んでもらいたいです。レビュアーに対してどう質問すればいいのか、といった点のヒントにもなるはずです。

幅広く触れられている本のため、一度読めば日々の文書作成に何かしら活かせることがあるはずです。

特に学びになったポイント

ここからは個人的に特に学びになったポイント、心に残ったポイントについて簡単にまとめます。

自転車を「知らない」と描けない

「よく見ないと書けない」という意味だと思っていました。しかし、「自転車がどういう仕組みで動くのかと言うところまで理解していると見なくても描ける」というところまで話はつながります。「知っている」のレベルが思っていた以上の深さでした。

全部並べていちばんよい一文を早く見つける

まさに私は何度も文章を直接書き直して、どのテイストが良かったのか、どの部分を直していのか、わからなくなることが多発していました。

スペルミスが心配ならATOKに頼ろう

文字の変換ツールについて調べたことがなかったのでとても嬉しい情報でした。

どう直すべきかを具体的に書こう

レビュアーが意識するべきポイントです。ソースコードレビューで同じようなことを思っており、とても共感しました。

文章を書くのは楽しい

あとがきにコバルト文庫が登場しました。胸熱でした。

紹介されていた「テクニカルライティング試験」を受験しようと思っています。次の受験への申し込み期限は12月24日です。気になる方は要チェックです!

Discussion