はじめに
『日本語スタイルガイド』を読みまして、さらにエンジニアとして具体的な文書作成術を知りたいと思い、読みました。
感想や特に印象に残った点について残しておきます。
まとめ＆感想
『日本語スタイルガイド』を読んでいれば精読する必要はないと感じました。
その上でこの本で良いと思ったのは、最後に文書作成の具体例があり、どのように実践するかが書いてある点です。文書作成術を学んでいる時には、「それで、実際具体的にどう書くの？」となることが多いです。なので、自分がドキュメントを書く際の助けになるのではないでしょうか。
さらには、内容からのアプローチのみではなく、見た目や箇条書きの見せ方のコツにも触れています。『日本語スタイルガイド』とはまた違った、ちょっとしたコツで読みやすいドキュメントを書くtipsを得ることができたのは良かったです。
特に印象に残ったところ
- 最も重要な内容を先に書く
- 「など」が示している対象を明確にする
- 「〜など」→「〜などのプログラミング言語」
- 補足や自分の意見を括弧付で書かない
- 1分が長くなり、冗長で理解しづらい文になる
- 行頭記号は黒の面積が大きいものを上位階層にする
- ■●▼ のように
- 操作と結果は明確に分けて書く
