エンジニアがテクニカルライティングのスキルを高める方法

エンジニアにとって、分かりやすい開発ドキュメントを書くには、テクニカルライティングのスキルが重要になります。

私はエンジニアからテクニカルライターになりました。この経験をもとに、テクニカルライティングにはどんなスキルが重要なのか、どう身に付ければよいのかをまとめます。

著者
Hiroki Zenigami

テクニカルライター。開発者向けのドキュメントを書いています。元エンジニア。共著で「現場で使えるRuby on Rails 5」を書きました。

目次

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

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

ある製品について、利用者に分かりやすく伝えること

をいいます。この定義については、「テクニカルライティングとは何か」をご覧ください。

テクニカルライティングの例としては、次のようなものがあります。

  • 電子レンジの取扱説明書
  • APIリファレンス
  • 社内の開発ドキュメント

こういった広い意味での製品について、利用者に分かりやすく伝えることがテクニカルライティングになります。

テクニカルライティングに重要なスキル

テクニカルライティングをする上では、次の3つのスキルが重要になります。この定義については、「テクニカルライターにとって重要なスキル」をご覧ください。

  • 製品に関する技術力
  • 分かりやすく伝える文章作成力
  • 文章に関わる人とのコミュニケーション力

エンジニアの方であれば、技術力とコミュニケーションについては、ふだんの業務で身に付くと思います。ただ、文章作成力については、自分で努力する必要が出てきます。

この文章作成力を身に付ける方法について、次に説明していきます。

テクニカルライティングのスキルを高める方法

テクニカルライティングのスキルのうち、自分で身に付けるべき「文章作成力」を高めるには、技術ブログを書くことがもっとも効率がよいと考えています。

技術ブログとは、技術的な内容についてブログに書くことです。例えば、プログラミングのことや、エラーの解決方法などを書きます。

なぜ技術ブログがよいかというと、文章作成力は繰り返し書かないと身に付かないためです。技術ブログは、自分のペースで、繰り返し書けるというメリットがあります。

このときに重要なのは、ただ書くのではなく、「読者に伝えることを意識して書く」ことです。

はじめはうまく書けないかもしれませんが、これはまったく問題がありません。書き続けることで、次第に文章作成力が身に付いていきます。

技術ブログの始め方について詳しくは、「技術ブログ入門」をご覧ください。また、技術系の文章の書き方について詳しくは、次の記事をご覧ください。

学び続けるコツ

テクニカルライティングについて学び続ける、つまり技術ブログを続けるコツは、とにかくどんどん書くことです。

「どんどん書く」というのはつまり、文章にこだわりすぎないことです。文章に納得できないと下書きのままになったりしますが、下書きがたまるとモチベーションが下がってしまいます。

こうならないためにも、まず公開することが大切です。公開して、あとからふりかえる。この繰り返しで、文章作成力が身に付いていきます。

私も2013年から技術ブログを書いていますが、つい最近書いた記事でも、もっというとこの記事ですら、書いた後で「もっとよく書けたはず」と思います。

こう思いつつも公開しています。公開して、反省点を次に生かす。これが、テクニカルライティングのスキルを高めるコツだと思います。

まとめ

テクニカルライティングとは、ある製品について、利用者に分かりやすく伝えることです。そのために必要なスキルには技術力と文章作成力、コミュニケーション力があります。

このうち業務では高まりづらい文章作成力については、技術ブログを書き続けることで身につけることができます。

著者
Hiroki Zenigami

テクニカルライター。開発者向けのドキュメントを書いています。元エンジニア。共著で「現場で使えるRuby on Rails 5」を書きました。

\ よかったらフォローしてください /
関連記事関連書籍
人気記事
applis
アプリケーション開発について学ぶブログ
お問い合わせ
ご意見・ご質問やお仕事のご依頼などは以下よりお願いいたします
お問い合わせ
© 2020-2022 applis