技術ライティング - 百科事典

技術文書作成は、今日の多くの工業や科学組織が、ユーザーに複雑な情報を明確かつ正確に伝えるために使用する専門的なコミュニケーション形式です。組織の顧客、従業員、組み立て作業員、エンジニア、科学者などは、この形式のコンテンツを参照してタスクを完了したり、主題を研究したりする最も一般的なユーザーです。ほとんどの技術文書は、複雑な情報を明確かつ正確に説明するために、単純化された文法を用いて、理解しやすい視覚的コミュニケーションをサポートしています。技術文書作成は、主題の正確な研究と、収集した情報を、最終ユーザーが簡単に理解したり関連付けたりできる書式、スタイル、読みやすさに変換する労働集約的な書き方です。技術文書には主に2つの形式があります。最も一般的な技術文書は、訓練された専門家と一般の大衆の両方に理解できるように書かれた手順文書です（例：標準的なステップバイステップのガイドや標準作業手順（SOP））。手順的な技術文書は、ユーザーの操作、組み立て、インストール手順、および従業員の作業/安全手順を単純かつ明確に説明するために、全ての種類の製造業で使用されます。書かれた手順は、製造、ソフトウェア開発、医療研究、多くの他の科学分野で広く使用されています。ソフトウェア業界は、技術文書の最も大きなユーザーの一つになり、プログラムのユーザーオペレーションやインストール手順を説明するための手順文書に依存しています。

一部のアプリケーションでは、技術文書はその分野の技術専門家や同僚の科学者のためにも書かれます。これらのアプリケーションでは、「ホワイトペーパー」形式の技術文書が、専門的なトピックを説明し、製品/サービスや意見/発見を特定の読者に宣伝するために使用されます。組織は通常、ホワイトペーパー形式を使用して、業界ジャーナルの記事や学術論文として技術文書を発表します。ホワイトペーパー形式は、技術的なトピックに詳しい読者に訴えるために書かれています。手順的な技術文書とは異なり、ホワイトペーパーにはユニークな業界用語やデータが含まれることが多いです。時には「科学的技術文書」と呼ばれるこの二次的な技術文書形式は、読者に論文の結論に同意させることを目的とするため、主題とその分野についての深い知識を示す必要があります。この形式の技術文書は、しばしば技術作家によって ghost written されます。技術作家は、組織の業界専門家と緊密に協力してこれらの文書を作成しますが、公開されたバージョンではほとんど信用されません。

しかし、多くの場合、技術文書は、理解の範囲が広い最終ユーザーに複雑な科学的または専門的な主題を伝えるために使用されます。すべての読者が内容を理解できるように、平易な言葉（PL）が従われて、事実のみが提供されます。現代の手順的な技術文書は、詳細な説明や不必要な情報（例：人称代名詞、抽象的な言葉、未知の略語）を避け、単純な言葉や短い文を使用して、適切な文法を実現しています。技術文書の文法は、ストンクとホワイトの本「スタイルの要素」で提供されるより完全な説明に従っています。技術文書の文法は、印刷ジャーナリズムに非常に似ており、非常に似た文法スタイルを従っています。

技術文書は、工学、医療、科学などの分野の作業に不可欠な役割を果たしていますが、これらの分野の学位は必要ありません。代わりに、文書の著者は技術文書の専門家でなければなりません。組織の専門知識エキスパート（SME）、内部規定、形式化されたエンジニアリングレビュープロセスが、正確性を確保するために依存されています。労働の分業は、組織の文書の両方に焦点を当て、より高い正確性と品質を確保するのに役立ちます。ほとんどの技術作家は、技術コミュニケーション、ジャーナリズム、英語、技術ジャーナリズム、コミュニケーションなどの書き手の分野の自由芸術学位を取得しています。技術文書作成は、技術コミュニケーション分野の最大のセグメントです。

技術文書が必要な分野の例には、コンピュータハードウェアとソフトウェア、建築、工学、化学、航空、ロボティクス、製造、財務、医療、特許法、消費者電子機器、バイオテクノロジー、林業などがあります。

概要
技術文書は、最も一般的には訓練された技術作家によって行われ、彼らが作成する内容は、明確で定義されたプロセスの結果です。技術作家は、共有する技術文書が一貫して標準化され、広く使用される形式とスタイル（例：DITA、markdown形式、AP Stylebook、Chicago Manual of Style）で表示されるように厳格なガイドラインに従います。技術作家の主要な仕事は、最も明確かつ効果的な方法で技術情報を伝えることです。最高の明確性を達成するために、組織の技術文書は読者にとって区別が難しくなるべきで、設定された形式、文法、および/またはスタイルの間に変化がないようにすべきです。技術作家の専門分野はしばしば複雑であり、強い書き手とコミュニケーションスキルが必要です。技術文書は、書き込み通信に限られていません。視覚的コミュニケーションが文書に組み込まれて、複雑なトピックを簡素化するのに役立ちます。技術作家は、様々な現代の画像とグラフィックス編集ソフトウェアを使用して、視覚的コミュニケーションを生み出します。図や図面、CADエクスプロージョンを編集するソフトウェアは、この分野の一般的なツールです。

一部のケースでは、エンジニアが彼らが取り組んでいるプロジェクトの技術文書を執筆することがありますが、製品が週に数回リリースまたは修正される大きな組織ではほとんど見られません。ビジネスの側面では、マーケティング資料やプレスリリースは、マーケティング分野や創造的な書き手に訓練された作家によって書かれることが多いです。しかし、技術作家は、組織が作成するあらゆる技術的なコンテンツに対して編集や他の入力を提供するために依存されることがあります。

歴史
技術文書は第二次世界大戦中以降、職業として認識されるようになりましたが、その根は古代エジプトにまで遡ります。そこでは、手順を説明するために定期的に視覚的コミュニケーションが使用されていました。古代ギリシャやローマ時代には、アリストテレスやデモクリトスなどの作家の作品が、最も初期の書き込み技術的な文書として引用されています。現代の手順的な技術文書の最も初期の例は、初期の錬金術者にまで遡ります。これらの初期の科学者は、私たちが今知っている「レシピ」として知られるものを開発しました。西欧文明における最も初期の書かれた手順的な手順の発見は、1100年にまで遡ります。しかし、古代インドや中国では、視覚的コミュニケーションが手順を説明するために古くから使用されていました。

機械印刷機の発明、ルネサンスの始まり、理性の時代の到来により、発見の記録化が必須となりました。アイザック・ニュートンやレオナルド・ダ・ヴィンチなどの発明家や科学者が、彼らの発明や発見を記録する文書を作成しました。これらの文書は、出版時期には技術文書と呼ばれなかったものの、現代の技術的なコミュニケーションと書き方の発展に重要な役割を果たしました。

技術コミュニケーションの分野は、産業革命の間に成長しました。ますます複雑化する新たな機械の使用方法を人々に説明するために、増加する必要性がありました。しかし、過去のようにスキルが口頭伝承で受け継がれていたのとは異なり、これらの新しい装置を使用する方法を知るのは発明者以外の誰もいませんでした。そのため、書き込みは情報を迅速かつ効果的に広める最も速い方法となり、これらの装置を文書化できる作家が必要とされました。

20世紀には、技術文書の必要性が急増し、職業として公式に認識されるようになりました。第一次世界大戦や第二次世界大戦の出来事は、医学、軍事ハードウェア、コンピュータ技術、航空技術の進歩につながり、これらの技術の使用をサポートするためのよく設計された文書が必要となりました。この時期には、技術文書が非常に需要があり、「技術作家」という正式な職種が第二次世界大戦中以降に確立されました。

第二次世界大戦後、技術の進歩により消費者製品と生活水準が向上しました。戦後のボームの間に、図書館や大学などの公共サービスやバスや高速道路などの交通システムも大幅に成長しました。これらのプロセスを記録するために作家が必要とされる必要性も増しました。また、この期間には、大企業や大学がコンピュータを使用し始めました。特に、1949年にジョセフ・D・チャプラインが最初の計算機技術文書を執筆しました。それは、BINACコンピュータのためのインストラクションマニュアルでした。

1947年にトランジスタが発明され、コンピュータがより安く、個人や小規模ビジネスでも購入可能な範囲になりました。これらの「パーソナルコンピュータ」の市場が拡大するにつれて、これらのデバイスを説明し、ユーザーマニュアルを提供する作家が必要とされる必要性も増しました。技術文書の職業は、1970年代から1980年代に消費者電子機器がより多くの人の家に侵入するにつれてさらに拡大しました。

近年、社会におけるコンピュータの重要性が高まり、デジタル通信の分野に多くの進歩がもたらされました。これにより、技術作家が使用するツールに変化が生じました。ハイパーテキスト、ワードプロセッサ、グラフィックス編集プログラム、ページレイアウトソフトウェアが、技術文書の作成をより迅速かつ簡単にし、今日の技術作家はこれらのプログラムに熟練している必要があります。

技術文書
技術文書は、情報と聴衆に応じて多くのジャンルや書き方をカバーします。一般的に使用される技術文書の例には以下のようなものがあります：

API文書：主にウェブ開発分野で、アプリケーションプログラミングインターフェース（API）を使用して個々のウェブアプリケーションの操作手順や修正を文書化するために使用されます。一般的なAPIツール、例えばSwaggerやPostmanは、技術作家が特定のAPIディレクトリに関連するコード（例：ローカライズ、ログイン、セキュリティ）にアップロードするためにmarkdown形式の文書を作成するのに役立ちます。API文書は、ほとんどの場合、APIツールのWYSIWYGエディタ内で標準的な「markdown」形式に自動的に変換されます。多くの場合、技術作家は新しいコードの更新が適用されたときにディレクトリソフトウェアのインストラクションの更新をアップロードします。ウェブディレクトリは通常「Git」に保存および更新され、プログラマーが更新されたディレクトリをテストサーバーに移動し、その後ライブサーバーに移動することが簡単になります。

組み立て手順（AI）：組み立てラインの従業員のための内部プロセスを提供します。個々の手順は書かれ、組み立てチームのメンバーに割り当てられます。技術作家は、複雑な組み立てを簡素化するためにCADエクスプロージョンを含めることが多いです。

ケーススタディ：長期間にわたって研究された個々の人物、グループ、または状況に関する公開された報告書；また、実際の生活で観察したり研究したりすることで何かを学ぶことができる状況です。大規模な組織では、技術作家はケーススタディに対してコピー編集やghostwritingサービスを提供するだけでなく、国家の基準や規則に適合するためには、管理レベルの著作権が必要です。

コンポーネントメンテナンスマニュアル（CMM）：主に航空用途で、コンポーネントの重要な部分が修理または交換が必要である場合に、顧客に通知するために使用されます。すべてのコンポーネントに関するサービスブレットがCMMに統合および/または参照され、最新のコンポーネントの図面と情報が含まれます。CMMは航空輸送協会（ATA）のフォーマットに従い、ATA Spec 100/iSpec 2200の章に従います。

インストールマニュアル（IM）：製品やソフトウェアプログラムのインストールを現場で行うための手順を設計しています。

検査報告書：主に大規模な建設や土木工学で使用され、現場検査者がプロジェクトの各段階で特定した構造問題/欠陥を詳細に示す報告書です。特定された問題/欠陥は、最初にリストとして捕捉され、技術作家が検査報告書を書くためにリストを参照します。検査報告書には、建設者が問題や修理を正しく行う方法をより簡単に理解できる詳細な問題/欠陥の画像、場所、説明が提供されます。場合によっては、推奨される解決策も含まれることがあります。

知識ベースまたはヘルプセンター：オンラインヘルプサイトで、製品や/またはサービスに関する技術情報のページを提供するために設計されています。これらのサイトのコンテンツは、SGML、XML、またはXHTMLで作成およびアップロードされます。技術文書のコンテンツ管理システム（CMS）が、これらのサイトの管理とアップロードに使用されます。

パッキングリストまたは出荷リスト：出荷された部品、製品の安全性に関するデータおよび製造者の連絡情報を識別します。

サービスブレット（SB）：主に航空用途で、コンポーネントの小さな部分に対して修理および/または改造が必要である場合に、顧客に通知するために使用されます。製造者が航空機所有者に作成し、発行するSBを発行します。SBは航空輸送協会（ATA）のフォーマットに従い、ATA Spec 100/iSpec 2200の章に従います。

仕様書または仕様：建設業界で、インストールの最低基準や要件を概説するために使用されます。仕様はプロジェクトマネージャーによって建設者に提供され、契約の一部として署名および承認される必要があります。フォーマット基準は、建設仕様協会（CSI）によって設定されます。

仕様シート/仕様シートまたはデータシート：一か二ページの参照シートで、特定のアプリケーションに必要な一般的な製品/サービスの特性を提供するために設計されています。一般的な製品/サービスの最大および最小特性には、サイズとフットプリント、重量、接続タイプまたはインターフェース、電気要件、速度などが含まれます。

標準作業手順（SOP）：軍事、製造、医療、および産業安全の従業員が、組み立て、処理、または他の物理的に正確な順序で完了する必要があるあらゆる作業タスクを完了するために参照する手順的な手順です。

調査報告書：土地測量の写真や技術データを収集し、測量者が概要を作成した土地測量の包括的な文書です。

技術的なマーケティングコンテンツ：マーケティング目的のために書かれた情報で、製品情報や仕様をマーケティング資料や製品/サービスのウェブページに説明する