Blog
非常に多くの種類の技術文書があるため、ここにすべてをリストすることはほとんど不可能です。
技術ライターとしての長いキャリアの中で、私は個人的に、プロジェクトごとに異なる15種類以上の技術文書を書いたに違いありません。
最も抽象的なレベルでは、技術文書は次のことができます。 内部ユーザーと外部エンドユーザー向けに作成されたものに分類されます。
たとえば、システム構成ガイドは「内部」ドキュメントの例ですが、インストールガイドは「外部エンドユーザー」ドキュメントの例です。
APIガイドは両方とも内部用です。および外部ユーザー。一方、クイックスタートガイドは、ほとんどの場合、外部のエンドユーザーを対象としています。
ユーザーガイド、トラブルシューティングガイド、リファレンスシート、リリースノート、（編集済み）マーケティング要件ドキュメント（MRD）、アーキテクチャおよびエンジニアリングドキュメント（A＆E Doc）、ヘルプファイル、標準操作手順（SOP）マニュアルなど。
存在する技術文書の種類を分類するには、さまざまな方法があります。私はそれらすべてを知っているつもりはありませんが、技術文書を分類するために使用できる2つの主な大まかなカテゴリは、ユーザーとユースケースです。
「ユーザー」とは、ユーザーのタイプはドキュメントを使用しますか？それは管理者ガイドですか、それともチュートリアルですか、それともユーザーガイドですか？これらのレベルの知識は、ドキュメントを設計するときに考慮されます。管理者ガイドは、ドキュメントを読んでいる人がチュートリアルの読者よりも少しだけ知っていることを前提としています。
「ユースケース」とは、ドキュメントが何に使用されているかを意味しますか？これは、ミサイルの発射方法に関する軍事文書から、グラフィックAPIを使用してビデオゲームを開発する方法に関する開発者文書まで多岐にわたります。
質問を絞り込むことができれば、私はできるかもしれません。あなたが探しているものをもっとあなたに与えるために。