- すべての開発者はコードを書くのは得意だが、より優れたエンジニアになるには文章を書く技術を高める必要がある
なぜ書くべきなのか?
- 書くことは頭の中を整理する方法
- 書くことは何かを学ぶ方法
- 書くことはミスを見つけやすくしてくれる
どうすればもっと書けるのか?
- 覚えておくべきこと: 読むことは習慣であり、書くことは技術である
- 技術を身につけるには、もっと書かなければならない
- もっと書くための簡単な方法のひとつは、設計レビューへの取り組み方を変えること
- それを嫌がって宿題のようにやるのではなく、情熱を持って取り組んでみること
- 設計レビューを書くたびに、何かを改善してみること
- 要点を外さずにもっと短く書いてみたり、より多くのユースケースをカバーするためにあえて長く書いてみたりすること
- 仕事以外でも文章力を高めたいなら、ブログを始めてみること
- ブログの負担が大きいなら、Stack Overflow で質問に答えてみること。コードをコピーするのではなく、テキストコンテンツを提供することに集中する
- 最後のアドバイスは、Copy & Paste をしないこと。
- みんな GitHub や Google からコマンドをただコピーするだけなので、それが問題
- 非生産的になるのではと心配なら、書くコードの量や課題をどれだけ早く終えるかが評価基準ではないことを覚えておくこと
- 書くことは避けられない。好きでも嫌いでも、10x エンジニアになるには書かなければならない
- "ドキュメントを書き、設計レビューを書き、プレゼンテーションを作りましょう。書くことが上達するほど、より早く、より良いエンジニアになれます。"
1件のコメント
Google テクニカルライティング for エンジニア [英語]
テクニカルライティングの4大原則
開発者のためのテクニカルライティング10戒
テクニカルライティングをすっきり仕上げる原則