テクニカルライター：彼らは何ですか、そしてあなたはそれを必要としますか？
公開: 2022-03-11
作家は、プロの執筆の世界でいくつかの異なるポジションを埋めることができます。 業界外の企業は用語を誤用する傾向がありますが、各種類の作家は特定の役割を果たし、特定の義務を負っています。 あなたが彼らに可能な限り最高の仕事をさせたいのであれば、正しいタイプの作家を雇うことが不可欠です。
- 通常、本のように形式的ではなく、形式の長いコンテンツを作成する著者。
- コピーライターは通常、広告、ソーシャルメディアの投稿、製品の説明、およびその他のメディアの短い形式のコピーを作成します。
- テクニカルライター。通常、製品のドキュメントやヘルプセンターの資料を作成します。
- ブロガーは通常、Web公開用の中程度の長さのコンテンツに焦点を合わせています。
そしてもちろん、メディカルライターや非営利セクターの助成金ライターなど、業界固有の種類のライターもいます。 その上、彼ら全員がゴーストライターになることもできます。
今日の投稿のタイトルが示すように、私はこれらの役割の1つを掘り下げます。 具体的には、テクニカルライターについて話しましょう。
テクニカルライターとは何ですか？
新製品を購入したとしましょう。 あなたはそれを見つけて開き、部品の図、仕様、そしてそれがどのように機能するかについてのハウツー手順でいっぱいの50ページのマニュアルを見つけます。 やや複雑なので、マニュアルを参照する必要があります。
それはテクニカルライターが行うことであり、それは彼らがテクニカルライティングの役職を獲得した方法です。
「テクニカルライターは、取扱説明書、中級からエンドユーザー向けのマニュアル、リファレンスガイド、操作手順ガイド、ホワイトペーパー、専門的な製品説明などの会社のドキュメントを作成します。」 –テクニカルライター本社。
テクニカルライターによって作成されたコンテンツは、次のようなさまざまな目的で作成できます。
- 内部ビジネス使用コンテンツには、手順書、ユーザーガイド、マニュアル、サービスドキュメント、またはレポートが含まれます。
- 外部ビジネス使用コンテンツには、使用ガイド、修理ガイド、ナレッジベースのドキュメント、カスタマーサービスのドキュメント、およびクライアントの提案のドキュメントが含まれます。
したがって、テクニカルライターは、従業員ハンドブックの作成、社内ナレッジベースWikiの作成、またはカスタマーサービスデータベースやFAQの作成を支援する場合があります。 彼らは、製品の使用法に関するマニュアルを作成したり、内部整合性のためにビジネスプロセスを文書化したりする場合があります。 また、上位レベルのエグゼクティブチーム向けのレポートや提案を作成し、Cレベルとディレクター間のコミュニケーションを促進する場合もあります。
ご想像のとおり、これらはすべて「技術文書」、つまりテクニカルライターの見出しに該当します。 コンテンツ自体は、ご想像のとおり、技術的なものです。
テクニカルライターは次のようになります。
- プロジェクトごとに働くフリーランスの請負業者。
- 長期的な請負業者であり、ビジネスが追いつくまで、ビジネスに関するすべての文書化に取り組んでいます。
- パートタイムまたはフルタイムの従業員。業務全体で必要に応じてすべてを文書化します。
テクニカルライターがゴーストライターになることはめったにありません。 ゴーストライターは通常、署名記事を売ってお金と文章を交換します。 技術文書に署名記事が含まれることはめったにないため、通常のライターよりもゴーストライターを雇って作成する必要はありません。 期待はありません。
具体的には、テクニカルライターは何をしますか？
テクニカルライティングの幅広い分野は非常に複雑です。 ある会社の専門のライターは、別の会社のライターとはまったく異なる一連の責任を負う場合があります。
テクニカルライターの職務記述書に記載されている一般的な職務には、次のものがあります。
- 事業部門、プロセス、または製品の技術仕様を調査します。
- 論理的な順序で技術文書を計画します。
- ターゲットオーディエンスにとって何が必要で何がそうでないかを理解します。
- ドキュメントを作成、コピーエディット、および改良します。
- 必要に応じて図やその他のイラストを作成します。
- 関連する用語集、FAQ、または関連する用語の別のライブラリを維持します。
- 高レベルのビジネスで使用するための技術レポートまたは正式な提案を作成します。
多くの作家は、テクニカルライティングの証明書、出版されたジャーナル記事または既存の作品、およびその分野での長年の経験を持っています。 彼らはあなたの特定の業界でテクニカルライティングのキャリアを持っていることを示すことができるはずです。
タイヤの交換方法やターンシグナルの使用方法を説明した、車に付属のマニュアルは、テクニカルライティングの一部です。 また、エンドユーザーではなくメカニック向けのサービスマニュアルもあります。 自動車メーカーのウェブサイトにある顧客セルフサービスの知識ベースにも、技術的なコンテンツが満載です。
すべてのヘインズマニュアル、Googleのヘルプセンター、およびケーススタディのようなものでさえ、テクニカルライティングの例です。
テクニカルライターは、その分野の執拗な専門家である必要があります（ただし、必ずしも認定されている必要はありません）。 自動車メーカーのテクニカルライターは、自動車の設計を内外で理解する必要があります。 医療分野のテクニカルライターは、投薬を適切に文書化するために生化学について十分に知っている必要があります。 ビジネスのテクニカルライターは、プロセスドキュメントを適切に作成するために、ビジネスがどのように機能するかを理解する必要があります。
とは言うものの、テクニカルライターは、主題の専門家に最終製品をレビューして承認させることがよくあります。 たとえば、メディカルライターは実際の生化学者のレビューを受けて正確さを保証する場合があります。 製品マニュアルを作成するテクニカルライターは、会社に責任を負わせることができるものが何もないことを保証するために、発行される前に弁護士にそれを調べさせるかもしれません。
結局のところ、技術文書は正確である必要があり、適切な対象者向けに作成する必要があります。
自動車メーカーの例を再度使用するには、販売仕様書、ユーザーマニュアル、および修理マニュアルに同様の技術情報が含まれている必要があります。 ただし、最も価値のある情報はさまざまであり、技術的な詳細のレベルもさまざまであり、ドキュメントの範囲も変わります。
エンドユーザーにヘインズマニュアルを提供することは不適切です。 それは、車を購入しようとしている人、車のトラブルシューティングを探している人、そして車を専門的に修理する人はすべて異なるニーズを持っているからです。 ほとんどの人が自動車の知識を必要としているのは、エアダクトを交換したり、触媒コンバーターを交換したりするのではなく、方向指示器を使用してタイヤを膨らませることです。
テクニカルライターにはどのようなスキルが必要ですか？
テクニカルライターが効果を発揮するには、特定のライティングスキルとコミュニケーションスキルが必要です。
1.まず、彼らは非常に効果的なコミュニケーターである必要があります。 テクニカルライターは、正確で技術的な情報をエンドユーザーに伝えて、それを理解して解析する必要があります。 ガイドが理解しにくい複雑な情報でいっぱいになっていると、役に立たないほど混乱してしまいます。 単純すぎると、ユーザーは何の価値も得られません。
同時に、テクニカルライターは、対象分野の専門家に実際的な質問をする必要があるかもしれません。 彼らのドキュメントでは、彼らは持っていない質問に遭遇し、答えを見つけることができないかもしれません。 彼らは、関連する専門家に、ドキュメントについて知っておくべきことを尋ねる必要があります。 また、専門家はいつ停止するかわからない可能性があるため、テクニカルライターは、潜在的に長い応答から特定の値を抽出する方法も知っている必要があります。
2.関連して、テクニカルライターは自分の言語をしっかりと把握する必要があります。 彼らは彼らが言っていることを正確にし、特に彼らの聴衆を対象とした実用的な読解レベルに書く必要があります。 技術的な間違い、不適切な単語の選択、混乱した意味; 技術文書にとってはすべてひどいものです。
3.次に、詳細志向の視点が必要です。 テクニカルライターは、細部が正確である必要があるため、細部に注意を払う必要があります。 それらの詳細が必要かもしれないので、彼らは特定の詳細をグロスすることができません。
私たちは、自分自身だけでなく、クライアントのためにも、変換するブログコンテンツを作成します。
ヘッジファンドが株を選ぶなどのブログトピックを選びます。 次に、トップの座を獲得するために10倍優れた記事を作成します。
コンテンツマーケティングには、コンテンツとマーケティングの2つの要素があります。 両方で黒帯を獲得しました。
たとえば、あるWebサービスに関するハウツーガイドの1つで、次のように書くことができます。
「ダッシュボードにログインして、サイドバーの[レポート]セクションを見つけてください。」
私は技術文書を書いているわけではないので、それで十分です。 私は非常に簡単なハウツーガイドを書いています。 一方、テクニカルライターは次のように書くかもしれません。
「ダッシュボードから、上から3番目の左側のサイドバーにある[レポート]見出しをクリックします。」
技術文書の一部が特異性であるため、それらはより具体的です。 もちろん、それは一般的な例です。
4.テクニカルライターは、論理フローについても理解する必要があります。 ビジネスプロセスを文書化するとき、ライターは批判的思考スキルを必要とし、ステップは適切に順序付けられる必要があります。 たとえば、レシピを考えてみましょう。 一斤のパンを次々と焼く手順を、実行された順序で記述します。 ただし、一部を再編成できる場合があります。 たとえば、焼く前に生地を1時間プルーフする場合、最初に「オーブンを予熱する」ことをする理由はありません。 オーブンの中に何も入っていない状態で、オーブンをそんなに長く動かしたいと思う人は誰もいないでしょう。
自動車メーカーが異なれば、パターンも異なります。 ドキュメントが長くなったり大きくなったりするほど、選択肢が増え、規則を確立することがより重要になります。 自動マニュアルは、使いやすさから始まり、隠された機能やマイナーな修理に移る可能性があります。
5.これは、テクニカルライターの別の要件であるシングルソーシングと結びついています。 単一のソーシングとは、一連の情報を取得し、さまざまなオーディエンスを対象とした複数のコンテンツを作成することを意味します。 ユーザーマニュアルとヘインズマニュアルの車の例は良い例です。 どちらにも同じソース（メーカー）の同じ車に関する情報が含まれていますが、1つははるかに技術的です。
6.テクニカルライターの中には、基本的なコードやWeb開発の知識が必要な場合もあります。 たとえば、カスタマーサービスのドキュメントを作成するテクニカルライターは、Webベースのドキュメントを最初から、またはフレームワーク内で開始するのに十分なHTML、CSS、JavaScript、またはWiki構文を知っている必要がある場合があります。 テクニカルライターが純粋なテキストコピーを作成することはめったにありません。テクニカルライターと見なされるには、通常、別のスキルが必要です。
たとえば、フルスタック開発のテクニカルライターは、テクニカルライティングとプログラミングの2つのスキルを持っている可能性があります。 ライターがプログラマーでなくても、この種の正確なプログラマーコンテンツを作成する方法は他にありません。
誰でもテクニカルライターになることができますか？
正直なところ、違います。
たとえば、ソフトウェア開発会社が、ユーザーが理解しにくい、またはわかりにくいガイドを持っているとします。 その場合、解約率は平均よりも高くなり、書き込みが不十分なために、少数の顧客を失うことになります。
テクニカルライターは、対象分野の専門家と交流するために、詳細志向の個性と社交性の特定の組み合わせを必要とします。 多くの場合、テクニカルライターは、それについて適切に書くために、主題に学位または技術証明書を必要とします。
たとえば、メディカルライターは、医学またはコンピューターサイエンスで看護学の学位または4年の学位を取得する場合があります。 作家は、医療コンテンツのための特定のテクニカルライティングコースを受講することもできます。 修士号や博士号を取得する必要はありませんが、少なくとも学士号などの正式な教育が必要です。
多くのテクニカルコンテンツライターは、関心のある業界を選び、それに特化しています。
とはいえ、テクニカルライターは、フィールドに入るのに必ずしもこれらの学位を必要とはしません。 多くの場合、彼らが必要とするのは、英語またはライティング、ジャーナリズム、テクニカルコミュニケーション、またはエンジニアリングなどの技術分野の学位だけです（ただし、それはあまり一般的ではない傾向があります）。
私は10年以上ライターを務めてきましたが、ブロガーとしてはテクニカルライターとしては成長しませんでした。 確かにその方法を学ぶことはできましたが、自分の習慣の多くを抑制しなければなりませんでした（一人称視点で書く、または何気なく書くなど）。
テクニカルライターが必要ですか？
多分！
ほぼすべてのビジネスには、ある程度のビジネスライティングと技術文書のニーズがあります。 私は小さな操作を実行しますが、それでもハウススタイルガイド、コンテンツブリーフ、または自分のサイトのプライバシーポリシーなどを作成します。
ただし、テクニカルライターが必要だとは言えません。 オンラインテンプレートと内部ドキュメントに必要な下位標準との間で技術を書くことができます。
電話に出てクライアントと話すだけでなく、カスタマーサービスのニーズがある分野でビジネスを運営しているとします。 その場合、テクニカルライターにドキュメントを作成してもらうとよいでしょう。 レポートを生成したりATSを操作したりするための特定のプロセスを持つ大規模な部門がある場合、テクニカルライターはそれらのプロセスを文書化できます。
そしてもちろん、あなたのビジネスが技術的な製品を生産していて、その製品がペンや靴よりも複雑なものである場合、ユーザーのためのユーザーズマニュアルまたはオンラインヘルプセンターを作成することは良い考えである可能性があります。
それでも、すべての企業がマニュアルにテクニカルライターを使用しているわけではありません。 イケアを考えてみましょう。 彼らは、言語に関係なく、単一のドキュメントが全世界に関連することを望んでいることもあり、組み立て手順でピクトグラムのみを使用することで有名です。 テクニカルライターがそれらを作成したかもしれませんが、それはグラフィックデザインであるほど多くを書いていません。
米国労働統計局によると、テクニカルライターは年間平均約75,000ドルを稼いでおり、ハイエンドで高度なスキルを持つテクニカルライターは年間100,000ドルを超えていますが、これには十分な理由があります。 彼らは適切な状況で金で彼らの体重の価値があります。
テクニカルライターの採用を検討していますか？ テクニカルライターについて、またコピーライターやコンテンツライターとの違いについて質問がありますか？ コメント欄で教えてください！ このテーマについて、喜んでお手伝いし、会話を始めたいと思います。