テクニカルライターにとって重要な3つのスキル

私はエンジニアからテクニカルライターに転向しました。

エンジニアとテクニカルライターでは、もちろん必要なスキルが違います。テクニカルライターになった今、改めて「テクニカルライターにとって重要なスキル」を整理してみました。

エンジニアとして開発ドキュメントを書くには、あるいはテクニカルライターとして成長するには、どんなスキルがあるとよいのか。この記事が参考になれば嬉しいです。

著者
Hiroki Zenigami

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

目次

テクニカルライターにとって重要なスキル

テクニカルライターには、次の3つのスキルが重要になります。

  1. 技術力
  2. 文章作成力
  3. コミュニケーション力

この根拠について、次に説明していきます。

テクニカルライターとは

この記事でいうテクニカルライターとは、テクニカルライティングを主な業務とする職種です。テクニカルライティングとは、ひとことでいうと、

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

です。テクニカルライティングについて詳しくは、「テクニカルライティングとは何か」をご覧ください。

3つのスキルが重要な理由

この定義からいくと、「ある製品に関する知識」、つまり技術力が重要です。また、わかりやすく伝えるための文章作成力。この2つが重要だといえます。

ここでいう技術力とは、「技術に関する一般的な素養」のことをいいます。例えばAPIを公開している製品の場合は、APIリクエストを実行するための技術などがあります。他にも、製品に関するドメイン知識も重要です。

まとめると、技術の素養がありつつ、製品にも詳しい状態が理想的だといえます。

また、コミュニケーション力も重要です。開発ドキュメントを書くにあたっては、他の開発者や製品担当者など、いろんな方とコミニケーションを取ることになります。

技術力とコミニケーション力、これに加えて文章作成力を身に付けていることが、よりよいテクニカルライターだといえます。

スキルが不足しているとどうなるか

例えば技術力がないと、開発ドキュメントの内容が不正確なものになったり、開発ドキュメントを作成するのに時間がかかってしまいます。

また文章作成力がないと、読者にとって読みづらく、分かりづらい開発ドキュメントになってしまいます。

コミニケーション力がない場合は、開発ドキュメントの要件をうまく整理できなかったり、たくさんの時間を使った結果として不正確な開発ドキュメントが仕上がってしまいます。

技術力と文章作成力、コミニケーション力は、どれが欠けてもテクニカルライターとしての業務に影響が出てしまいます。この3つのスキルを身に付ける努力が必要だといえます。

コミュニケーションが苦手な場合

私は、テクニカルライターになる前はエンジニアやプロダクトマネージャーをしていましたが、コミニケーションが苦手でした。今でもテクニカルライターとして苦労している部分があります。

ただ、口頭でのコミニケーションは苦手ですが、Slackなどテキストベースでのコミュニケーションは得意です。自分の中でバランスをとりながら仕事をしています。

スキルの身につけ方

この3つのスキルは、どうやって身に付ければよいのでしょうか。ひとつの考え方を紹介します。

エンジニアの場合

エンジニアの方は、文章作成の練習をします。

エンジニアなら、ふだんの業務の中で、技術力とコミニケーション力は自然に身に付くと思います。設計をしたりコードを書いたりすることで、技術力が身に付きます。

また、開発の過程で他のエンジニアやデザイナー、プロダクトマネージャーの方とコミュニケーションをとると思います。

一方で、業務の中で文章を書くことはあまり多くないと思います。加えて、文章作成力を身に付けるには、ただ書くのではなく、ある程度の方法論を学んだ上で量をこなす必要があります。

方法論については、「開発ドキュメントの書き方」をご覧ください。また書く場所については、技術ブログがいいと思います。こちらについては「技術ブログ入門」が参考になります。

テクニカルライターの場合

テクニカルライターの方は、技術力を身に付けます。

ふだんの業務の中で、文章作成力とコミニケーション力については身に付いていくと思います。これに加えて、技術力を身に付ける努力をします。

技術力を身に付ける方法のひとつとして、例えば個人開発があります。具体的には、ウェブサービスやライブラリをつくってみます。

技術力を身に付ける努力をしつつ、ふだんの業務で文章作成力やコミニケーション力を高めることで、よりよいテクニカルライターになれると思います。

その他のスキル

テクニカルライターにとって重要なその他のスキルとして、英語があります。英語は、もちろん英語のドキュメントを書く場合にはとても重要になります。

特に、開発ドキュメントについては英語で書くことがルール化されている会社も多いと思います。他にも、RFCなど一次情報が英語の場合もあります。

ただ、英語をネイティブレベルで読み書きできる必要はないと思います。例えばDeepLのような翻訳ツールを使いつつ、基本的な読み書きができるレベルの英語力があればよさそうです。

ということで、必要に応じて英語も身につけた方がよいです。ただ、英語はテーマが広すぎるので、「英語を一旦捨てる」と割り切るのも、テクニカルライターの生存戦略としてはありだと思います。

おわりに

テクニカルライターにとって重要なスキルとして、技術力と文章作成力、コミニケーション力の3つを紹介しました。

ふだんの業務に加えて、不足しているスキルを身に付けることで、よりテクニカルライターとして成長できると思います。

著者
Hiroki Zenigami

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

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