概要

先日から開催されている技術書典 16で購入した表題の本について、感想を書きました。

この記事は誰向けの内容か

本書に興味を持っているが、購入を悩んでいる人
本書を購入して他人の感想が気になった人

この記事は誰向けの内容ではないか

本書について興味がない人

この記事を読んだ後にどんな状態になるか

本書で学べることが分かるはず

この本を読もうと思ったきっかけ

技術書典 16 のおすすめ本をツイッターなどで探していて、目についたのがきっかけになります。普段の業務はリモートワークのため、以下のように文章を書く機会がとても多いです。

slackでの報告・連絡・相談
社内Wikiに手順書やナレッジを書く
チケットに調査内容や実装方針を書く

これらの文章を分かりやすく記述するために、役立つことがあればと購入を決意しました。

本の概要

techbookfest.org

良かったこと、理解したこと

そもそもテクニカルライティングとは

テクニカルライティングとは実用文を分かりやすく書くための技術です。

そして実用文とは以下のような文章のことです。

対象となる「何か」について論理的かつ簡潔に説明してをしていてそれを読むことで何をどうすればいいのかが分かるような文章

業務で書く文章の大半は、この定義に当てはまると思うので、社会人には必須な技術だと感じました。

文章を書くにあたって

ある対象について文章を書くためには、対象を深く理解する必要があると理解しました。確かに対象への理解が浅いと、解像度の低い情報しか伝えることができません。

例えば、「りんごは赤い果物です。」としか説明できないのと、「りんごはバラ科リンゴ属に属する果物で、寒冷地帯で栽培が盛んです。」だと得られる情報は変わってきます。もし曖昧な言葉しか出てこないなら、もう少しインプットすることを心がけようと思います。

レビューに関する心構え

文章のレビューについて書かれていましたが、他のレビューにも応用できる考え方を知れて良かったと感じています。

指摘は素直に受け入れる

「好みかもですが―」みたいな指摘を受けたときは、やらない理由を考えてしまうことがありますよね。より良くする視点で指摘をしてくれているので、基本的には修正することで品質は向上して後悔することは少ない、というのは確かにと思いました。時間がないとか言い訳をせずに、手を動かすことを心がけたいです。

レビュアーが気づいたことに、書いたとき気付けなかったのは当然

この視点が自分にはなくて、「こんな簡単なことも気付けなかった……」と落ち込むことがありました。しかし、レビュアーはレビューに100%のリソースを使っている一方、レビューイは成果物を作る際に多くのことにリソースを使っています。そのため、気付けることに差が出るのは当然ということです。必要以上に落ち込むことなく、指摘に感謝して修正するようにしたいと思いました。