テクニカルライティング

テクニカル ライティングは、今日の多くの産業および科学組織で、複雑な情報をユーザーに明確かつ正確に伝えるために使用されている特殊なコミュニケーション形式です。組織の顧客、従業員、組立作業員、エンジニア、科学者は、タスクを完了したり、主題を調査したりするためにこの形式のコンテンツを参照する最も一般的なユーザーの一部です。ほとんどのテクニカル ライティングは、複雑な情報を明確かつ正確に説明するために、わかりやすい視覚的なコミュニケーションに支えられた簡略化された文法に依存しています。

テクニカル ライティングは、主題の正確な調査と、収集した情報をエンド ユーザーが簡単に理解または共感できる書式、スタイル、および読解レベルに変換することを要求する、労力のかかる形式のライティングです。テクニカル ライティングには、主に 2 つの形式があります。これまでのところ、最も一般的な形式のテクニカル ライティングは、一般向けに書かれた手順書です (標準化されたステップ バイ ステップ ガイドや標準操作手順 (SOP) など)。手順書形式のテクニカル ライティングは、あらゆるタイプの製造において、ユーザー操作、組み立て、インストール手順、および人員作業/安全手順を説明するために使用されます。文書化された手順は、製造、ソフトウェア開発、医療研究、およびその他の多くの科学分野で広く使用されています。ソフトウェア業界は、テクニカル ライティングの最大のユーザーの 1 つに成長しており、プログラムのユーザー操作およびインストール手順を説明するために手順書に依存しています。

いくつかの用途では、テクニカル ライティングは、仕事や研究の分野の専門家や科学者仲間向けに書かれることがあります。これらの用途では、「ホワイト ペーパー」形式のテクニカル ライティングを使用して、専門的なトピックを説明し、特定の読者に製品/サービスまたは意見/発見を売り込みます。組織は通常、ホワイト ペーパー形式を使用して、業界ジャーナルの記事または学術論文としてテクニカル ライティングを公開します。ホワイト ペーパー形式は、技術的なトピックに精通している読者にアピールするように書かれています。手順書形式のテクニカル ライティングとは異なり、ホワイト ペーパーには独自の業界用語やデータが含まれることがよくあります。科学的なテクニカル ライティングと呼ばれることもあるこの二次的な形式のテクニカル ライティングでは、読者に論文の結論に同意するよう説得することを唯一の目的として、主題と仕事の分野に関する深い知識を示す必要があります。^[1]この形式のテクニカル ライティングは、テクニカル ライターによって代筆されることがよくあります。テクニカル ライターは、組織の業界の専門家と密接に協力してこれらのドキュメントを作成しますが、公開バージョンにクレジットされることはほとんどありません。

しかし、ほとんどの場合、テクニカル ライティングは、複雑な科学的またはニッチな主題を「素人」の言葉でエンド ユーザーに伝えるために使用され、純粋に事実に基づいた内容が含まれています。現代の手順書のテクニカル ライティングは、人称代名詞、抽象的な言葉、なじみのない頭字語などの不要な情報を含む詳細な説明ではなく、簡単な用語と短い文に依存しています。正しい文法を実現するために、手順書は、能動態とフォーマルな口調で、第三者の客観的な視点から書かれています。テクニカル ライティングのスタイルに関するより完全な説明は、Strunk と White の著書「The Elements of Style 」に記載されています。テクニカル ライティングの文法は、印刷ジャーナリズムと非常に似ており、同じスタイルに従います。^[2]テクニカル ライティングは、エンジニアリング、ヘルスケア、科学の分野で不可欠な役割を果たしていますが、これらの分野の学位は必要ありません。代わりに、ドキュメントの作成者はテクニカル ライティングの専門家である必要があります。組織の主題専門家(SME)、内部仕様、および正式なエンジニアリング レビュー プロセスが、正確性を保証するために頼りにされています。分業により、組織の文書作成の両面に重点が置かれ、精度と品質が向上します。ほとんどのテクニカルライターは、テクニカルコミュニケーション、ジャーナリズム、英語、テクニカルジャーナリズム、コミュニケーションなどのライティング分野の教養学位を取得しています。テクニカルライティングは、テクニカルコミュニケーション分野で最大のセグメントです。^[3]

テクニカルライティングを必要とする分野の例としては、コンピューターのハードウェアとソフトウェア、建築、エンジニアリング、化学、航空学、ロボット工学、製造、金融、医療、特許法、家電製品、バイオテクノロジー、林業などが挙げられます。

テクニカル ライティングは、訓練を受けたテクニカル ライターが行うのが最も一般的で、作成するコンテンツは明確に定義されたプロセスの結果です。テクニカル ライターは厳格なガイドラインに従うため、共有する技術情報は、単一の一般的に使用されている標準化された形式とスタイル ( DITA、マークダウン形式、AP スタイルブック、シカゴ マニュアル スタイルなど) で表示されます。テクニカル ライターの主なタスクは、技術情報を可能な限り明確かつ効果的な方法で伝えることです。^{[4] : 4  [5]}最高レベルの明瞭性を実現するには、組織のテクニカル ライティングの作成者は、確立された形式、文法、および/またはスタイルに変化がなく、読者にとって区別がつかないものでなければなりません。テクニカル ライターが伝える主題は複雑な場合が多いため、強力なライティング スキルとコミュニケーション スキルが不可欠です。テクニカル ライターは、テキストで情報を伝達するだけでなく、最新のグラフィック ソフトウェアに精通している必要があります。テクニカル ライターは、イラスト、図、CAD爆発図を作成および編集するために、さまざまなプログラムを使用します。最新のグラフィック ソフトウェアに習熟していることは、ほとんどのテクニカル ライティングの要件です。^[6]

場合によっては、エンジニアが取り組んでいるプロジェクトのテクニカル ライティングを行うこともありますが、製品を毎週リリースまたは改訂しなければならない大規模な組織では、このようなことはめったに起こりません。ビジネス面では、マーケティング資料やプレス リリースは通常、マーケティング分野やクリエイティブ ライティングの訓練を受けたライターによって作成されます。ただし、組織が作成するテクニカル コンテンツの編集やその他の入力は、テクニカル ライターに任せることができます。

テクニカル ライティングが職業として認識されるようになったのは第二次世界大戦以降のことですが、その起源は古代エジプトにまで遡ります。そこでは、手順を説明するために視覚的なコミュニケーションが頻繁に使用されていました。古代ギリシャとローマの時代には、アリストテレスやデモクラトゥスなどの作家によるテクニカル ライティングが、書かれたテクニカル ライティングの最も初期の形式として挙げられています。現代の手順書と見なされるテクニカル ライティングの最も初期の例は、初期の錬金術師にまで遡ります。これらの初期の科学者は、現在「レシピ」として知られているものを開発しました。西洋文明における書かれた手順の最も初期の発見のいくつかは、西暦 1100 年にまで遡ります。ただし、視覚的なコミュニケーションは、それよりずっと以前から、古代インドと中国で手順を説明するために使用されていました。

印刷機の発明、ルネッサンスの始まり、理性の時代の到来とともに、発見を文書化することが必要不可欠となった。アイザック・ニュートンやレオナルド・ダ・ヴィンチのような発明家や科学者は、発明や発見を記録した文書を作成した。^{[7] : 1}出版当時は技術文書と呼ばれることはなかったが、これらの文書は現代の技術的なコミュニケーションや執筆の形態の発展に重要な役割を果たした。^[7]

技術コミュニケーションの分野は産業革命の時代に成長しました。^{[8] : 3}発明された機械がどんどん複雑になり、その使い方を人々に教える必要性が高まっていきました。^{[8] : 8}しかし、昔は技術が口承で伝承されていたため、発明者以外は誰もこれらの新しい装置の使い方を知りませんでした。そのため、書くことが情報を広める最も速くて効果的な方法となり、これらの装置を文書化できるライターが求められました。^[8]

20 世紀には、テクニカル ライティングの需要が急増し、この職業が正式に認められるようになりました。第一次世界大戦と第二次世界大戦の出来事により、医学、軍事ハードウェア、コンピューター テクノロジー、航空宇宙技術が進歩しました。^{[7] : 2}この急速な成長と戦争の緊急性が相まって、これらのテクノロジーの使用をサポートするために、適切に設計されたドキュメントがすぐに必要になりました。この時期、テクニカル ライティングの需要が高く、「テクニカル ライター」は第二次世界大戦中に正式な職名になりました。^{[7] : 1}

第二次世界大戦後、技術の進歩により消費財と生活水準が向上した。^{[7] : 3}戦後の好景気の間、図書館や大学などの公共サービス、バスや高速道路などの交通機関が大幅に成長した。これらのプロセスを記録するライターの必要性が高まった。^{[7] : 1}また、この時期に大企業や大学がコンピューターを使い始めた。特に、1949年にジョセフ・D・チャップラインが最初の計算技術文書であるBINACコンピューターの取扱説明書を執筆したことは注目に値する。^[9]

1947年のトランジスタの発明により、コンピュータはより安価に、個人や中小企業が購入できる範囲で生産できるようになりました。^{[7] : 3}これらの「パーソナルコンピュータ」の市場が拡大するにつれて、これらのデバイスを説明し、ユーザーマニュアルを提供できるライターの必要性も高まりました。^{[7] : 3} 1970年代と1980年代には、家電製品がますます多くの人々の家庭に普及するにつれて、テクニカルライティングの専門職はさらに拡大しました。^[7]

近年、社会におけるコンピュータの台頭により、デジタル通信の分野で多くの進歩がもたらされ、テクニカルライターが使用するツールにも変化がもたらされました。^{[7] : 3} ハイパーテキスト、ワードプロセッサ、グラフィック編集プログラム、ページレイアウトソフトウェアにより、技術文書の作成がより迅速かつ容易になりました。今日のテクニカルライターは、これらのプログラムに精通している必要があります。^{[4] : 8–9}

テクニカル ライティングには、情報と対象読者に応じて、さまざまなジャンルとライティング スタイルがあります。よく使用される技術ドキュメントの例を次に示します。

• API ドキュメント: Web 開発分野でのみ使用され、アプリケーション プログラミング インターフェイスの操作およびインストール手順を文書化します。API コーディング ツール (Swagger、Postman など) を使用すると、テクニカル ライターはマークダウン形式 でドキュメントを簡単に作成し、関連する API コード (ローカリゼーション API、ログイン API、セキュリティ API など) を含む特定の API ディレクトリにアップロードできます。API ドキュメントは通常、 API ツールのWYSIWYGエディター内で標準化された「マークダウン」形式に自動的に変換されます。ほとんどの場合、プログラマーとテクニカル ライターは、コードとコンテンツの更新を、Web サイトのミラー イメージが維持されている「Git」リポジトリにアップロードします。プログラマーは、テストが完了すると、更新されたディレクトリをライブ サーバーに移動します。
• 組立手順書 (AI) : 組立ラインの作業員に内部手順を提供します。個々の手順が記述され、組立チームのメンバーに割り当てられます。テクニカル ライターは、複雑な組立を簡素化するために CAD 分解図を含めることがよくあります。
• ケーススタディ：長期にわたって研究されてきた人物、グループ、または状況に関する公開されたレポート。また、何かを学ぶために調べたり研究したりできる現実の状況。 ^[10]大規模な組織では、テクニカルライターはケーススタディのコピー編集またはゴーストライターサービスのみを提供します。国の基準と規則を満たすには、通常、管理レベルの著者が必要です。
• コンポーネント保守マニュアル (CMM) : 主に航空宇宙で使用されるこれらのマニュアルは、包括的なコンポーネントの修理や変更のために作成されています。製造元は、コンポーネント全体を修理または交換する必要がある場合はいつでも、CMM を作成して顧客に発行します。すべてのコンポーネント関連のサービス速報は、完全なコンポーネント情報とともに、CMM に組み込んだり参照したりする必要があります。CMM は、航空宇宙輸送協会 (ATA) のフォーマットとATA Spec 100/iSpec 2200の章立てに従います。
• インストール マニュアル (IM) : エンド ユーザーが現場で製品またはソフトウェア プログラムをインストールできるように設計された手順。
• 検査レポート: 主に建設現場で使用され、現場で作業する検査員が特定した建設上の問題/欠陥の詳細が記載されたレポートです。特定された問題/欠陥はパンチ リストに記録され、テクニカル ライターは検査レポートを作成するときにこのリストを参照します。通常、パンチ リストの各項目には、問題/欠陥の画像、場所、および説明が提供されます。場合によっては、対策も提供されます。
• ナレッジベースまたはヘルプ センター: 製品やサービスに関する技術情報をユーザーに提供するオンライン ヘルプ サイト。テクニカル ライティング コンテンツのオンライン データベースを提供します。コンテンツは、SGML、XML、または XHTML で作成できます。テクニカル ライティングコンテンツ管理システムは、これらの Web サイトの管理とアップロードに使用されます。
• 梱包明細書または出荷明細書: 出荷された部品、製品の安全データ、および製造元の連絡先情報を識別します。
• サービス ブリテン (SB) : 主に航空宇宙で使用されるこれらのマニュアルは、軽微な修理や変更に関するものです。製造元は、コンポーネント内の個々の部品の変更または更新が必要になる可能性がある場合に、SB を作成し、航空機の所有者に発行します。SB は、航空宇宙輸送協会 (ATA) のフォーマットとATA Spec 100/iSpec 2200の章立てに従います。
• 仕様またはスペック: 建設業界で、設置の最低基準と要件を概説するために使用されます。仕様は通常、プロジェクト マネージャーによって建設業者に提供され、契約の一部として建設業者が署名して承認する必要があります。フォーマットの標準は、建設仕様協会 (CSI)によって設定されます。
• 仕様書/スペックシートまたはデータシート: 特定のアプリケーションに必要な共通の製品/サービス特性を提供するように設計された、1 ページまたは 2 ページの参照シート。共通の製品/サービスの最大および最小特性には、サイズとフットプリント、重量、接続タイプまたはインターフェイス、電気要件、速度などが含まれます。
• 標準操作手順 (SOP) : 軍事、製造、医療、産業安全担当者が、適切な順序で物理的に完了する必要がある組み立て、処理、またはその他の作業タスクを実行するために参照する手順。
• テクニカル マーケティング コンテンツ: マーケティング目的のみで作成された情報。このコンテンツは、マーケティング資料や製品/サービス Web ページで製品情報や仕様を説明するためによく使用されます。従来、この作業にはマーケティングを専門とするクリエイティブ ライターが雇用されています。
• ユーザー マニュアル (UM)または操作マニュアル: 製品またはプログラムの操作手順の説明。
• ホワイト ペーパー: マーケティング ドキュメント。多くの場合、テクニカル ライターが代筆し、分野の専門家が執筆者となります。すべてのホワイト ペーパーには説得力のある主題があり、著者の結論を裏付ける議論が提示されます。

テクニカル ライターは、ドキュメントの作成と提示に次のツールを使用します。

• CAD レンダリング: 機械工学に携わるテクニカル ライターは、エンジニアリングで作成および承認された 3D CAD 設計を「展開」するために、CAD レンダリング ツールをよく使用します。その目的は、組み立て/分解の手順を視覚的にわかりやすく伝えることです。通常は、「技術コミュニケーション」用に設計された専用の CAD ソフトウェアが使用されます。
• コラボレーションソフトウェアプログラム。テクニカルライティングには、組織内の異なる部門の複数の関係者間のコラボレーションが必要です。 ^{[4] : 57}関係者間のコミュニケーションを増やすために、テクニカルライターはConfluenceなどのWikiシステムや共有ドキュメントワークスペースに依存しています^{。 [4] : 74}
• コンテンツ管理システム(CMS):現代のテクニカル ライティングは、テクニカル ライティング用に設計された専用の CMS またはCCMSで編集および公開されます。CMS は、大量のテクニカル ライティング コンテンツを簡単かつ迅速にオンラインで公開するために使用されます。アップロードされたコンテンツは、エンド ユーザーが参照できるように、自動的に「ナレッジベース」ヘルプ システムに変換されます。基本的なWYSIWYG編集機能と Web アップロードに加えて、CMS はバージョン管理機能と大規模なドキュメント ワークフローを管理するための組み込みツールを備えたコンテンツ管理機能も提供します。テクニカル ライティングに使用されるほとんどの CMS は、 SGML、 XML、またはXHTMLベースです。
• デスクトップ パブリッシング ツールまたはワード プロセッサ: 1990 年代には、ほとんどのテクニカル ライティングはワード プロセッサ ツールを使用して行われていました。これらの初期のプログラムにより、テクニカル ライターはコンピューターからドキュメントの作成、編集、デザイン、印刷を行うことができました。ホワイト ペーパーの作成者は、一般に、デスクトップ パブリッシングにワード プロセッサと強化されたデスクトップ パブリッシング ツールに依存しています。 ^[11]
• グラフィックソフトウェア：画像やその他の視覚要素は、技術文書において、印刷されたテキストよりも簡単な言葉で情報を伝達するために使用されます。 ^{[4] ：306–307}これらの例では、文書の視覚要素（写真、アイコン、図など）を作成および編集するために、技術文書でよく使用されるグラフィックソフトウェアが使用されます。
• グラフ作成ソフトウェア。統計情報を伝えるために、テクニカルライティングにはグラフやフローチャートがよく使われます。^{[4] : 306–307}一般的なデータベースソフトウェアは、基本的なグラフやチャートを作成するためによく使用されます。時には、テクニカルライティングでは、インタラクティブなオンライン機能を備えたより洗練されたグラフを提供しなければならないこともあります。この作業には、SQLデータベースグラフ作成ソフトウェアがよく使用されます。^[12]
• スクリーンキャプチャツール:ソフトウェア手順のテクニカルライティングには、スクリーンキャプチャが含まれることがよくあります。 ^{[13] [14]}スクリーンキャプチャには、静止画と動画の2種類があります。静止画のスクリーンキャプチャは、ソフトウェア業界でよく使用されます。テクニカルライターは、より複雑な手順を説明するために、静止画のスクリーンキャプチャを含めることがよくあります。テクニカルライターは、ソフトウェア手順を示すために、デスクトップの短いビデオを録画するだけの場合もあります。ただし、ソフトウェアには多くの改訂版があるため、これはあまり一般的ではありません。
• 仕様ソフトウェア:クラウドベースの仕様ソフトウェアは、多くの場合、「仕様作成者/テクニカル ライター」が建設プロジェクトに必要な共通の最低基準のリストを選択するために使用されます。これらのプログラムは通常、建設仕様協会 (CSI)標準に準拠するようにフォーマットされています。

• 建設仕様協会 (CSI)
• チェコ技術コミュニケーション協会
• 欧州技術コミュニケーション協会
• IEEEプロフェッショナルコミュニケーション協会
• 科学技術コミュニケーター協会
• 国際ビジネスコミュニケーター協会
• 翻訳
• テクニカルコミュニケーション協会

• テクニカル ライティング教育プログラム - ロサンゼルス支部、テクニカル コミュニケーション協会(LASTC)
• IEEE プロフェッショナルコミュニケーショントランザクション
• Wikiversityのテクニカル ライティング コース