トップ «前の日記(2019-05-02) 最新 編集

2019-05-03 [長年日記]

_ 『技術者のためのテクニカルライティング入門講座』を読んだ

読んだので感想とともに紹介をば。

技術者のためのテクニカルライティング入門講座

AmazonアソシエイトアカウントがゴミクズすぎてBANされたのでそのままリンク貼るお。

対象

タイトルの通りテクニカルなドキュメントをこれから書き始めなきゃいけない人向け。主に業務になって初めて、日本語のドキュメントをたくさん書かなくてはいけなくなったけれど、何から始めればよいのかよく分からない人向け。

文字も大きく、全体的な体裁が比較的ポップめなので個人的にはあんまり好みじゃないんだけど、内容と対象とはマッチしていると思う。

総評

  • ライティングについて「初歩的な部分」からコンパクトに紹介されていてよい
  • 前半は基本、後半は実例で、実例はユーザーマニュアル、提案書、障害報告書、社外メール文というのも扱いやすい

ライティングというと鉄板ネタとして「作文技術」「文章作法」系があるんだけど、もっと実用に寄っていてかつある程度汎用的なワークフローの中に落とし込めるかという意味では、物足りなかったり、不必要に詳細だったりして、紹介しやすい本があまりないなーと感じていた。

簡単に言うと普通の人は論文や本のようにボリュームのあるものを「読んでもらえる」機会はほとんどない。コンパクトでかつ大切なことが必要十分に伝わるように書くことを求められる。また業務の場合、提出先があり、多くの場合は事前にレビューがある。

これまで自分は主に『ドキュメントハックス』を紹介するようにしていたんだけど、さすがに古くなってきていたのと、こちらの方が横書きで図表も豊富なので、まさに「今」に即しているように見える。今後はこれをまずテキストとして紹介していこうと思う。

使えそうな部分

  • まずは 1 から 3 章がやはり基本
  • 4章はやや伝統的なビジネス文書のルールに近い。押さえておくと「何か」とやりやすくなる
  • 5章以降は実践編*1
  • ドキュメントレビュー時に使う『リーダブルコード』のような位置付けで使うとよさそう
Tags: Book

*1 障害報告とか、原因も特定してねーし対策にもなってねーぞ、みたいな報告見ると萎え萎えなのでみんな気をつけてね