技術文書

ウィキペディアから、無料の百科事典
ナビゲーションにジャンプ 検索にジャンプ

技術文書は、製品、システム、またはサービスの使用、機能、またはアーキテクチャを (技術用語で)説明するために作成された情報のクラスの総称です。

技術文書のクラス

技術文書のクラスには、次のものが含まれる場合があります。

技術文書の標準化

歴史的に、ほとんどのクラスの技術文書は、形式、内容、および構造に関する普遍的な適合性(標準)を欠いていました。これを是正するための規格は、国際標準化機構(ISO)などの機関を通じて開発されており、技術製品ドキュメントのユーザーガイド、マニュアル、製品仕様などの作成規則に関する規格が公開されています。これらの規格はICS01.110でカバーされています。[1] ICS 01.110でカバーされていない技術製品のドキュメントは、以下のサブセクションにリストされています。

分野固有の

EU医療機器規制

EU医療機器規制に準拠した医療機器についても、技術文書が必要です規制の付属書II、技術文書、および付属書III、市販後調査に関する技術文書は、医療機器の技術文書の内容を説明しています。これには、たとえば、デバイスの仕様、ラベル付けと指示、設計と製造、安全性とパフォーマンスの要件、リスク管理、および臨床評価を含むデバイスの検証と検証に関する情報が含まれます。また、市販後調査からの情報

ソースデータのフォーマット

ドキュメントのアーキテクチャと入力

一部のドキュメンテーションシステムは、ドキュメンテーションセットを構成するドキュメンテーションの全体的なタイプまたは形式、およびドキュメンテーションがどのように作成、公開、またはフォーマットされるか(またはではなく)に関係します。

たとえば、Diátaxisフレームワーク(主にソフトウェアドキュメンテーションの分野で使用されます[8] )は、チュートリアルハウツーガイドリファレンス説明の4つの異なるユーザーニーズに対応する4つの異なるドキュメンテーションフォームを提供します[9]対照的に、DITAは、タスクコンセプトリファレンス用語集入力トラブルシューティングの5つの異なる「トピックタイプ」を主張しますが、RedHatのモジュラードキュメンテーションシステムは、コンセプトプロシージャリファレンスの3つの「モジュール」を使用します。[10]

も参照してください

引用

  1. ^ 「01.110:技術的な製品ドキュメント」国際標準化機構2009年6月10日取得
  2. ^ 「ISO15787:2001技術製品ドキュメント-熱処理された鉄部品-プレゼンテーションと表示」国際標準化機構2009年6月10日取得
  3. ^ 「ISO3098-0:1997技術製品ドキュメント-レタリング-パート0:一般要件」国際標準化機構2009年6月10日取得
  4. ^ 「ISO10209-1:1992技術製品ドキュメント-語彙-パート1:技術図面に関連する用語:一般および図面の種類」国際標準化機構2009年6月10日取得
  5. ^ 「ISO2162-1:1993技術製品ドキュメント-スプリング-パート1:簡略化された表現」国際標準化機構2009年6月10日取得
  6. ^ 「ISO5457:1999技術製品ドキュメント-図面シートのサイズとレイアウト」国際標準化機構2009年6月10日取得
  7. ^ ISO6433技術的な製品ドキュメント。パーツリファレンス、BSI英国規格、 2020年12月16日取得
  8. ^ 「Diátaxisドキュメントセットの部分的なリスト」2021年4月10日取得
  9. ^ 「Diátaxisドキュメントフォームの概要」2021年4月10日取得
  10. ^ 「RedHatモジュラードキュメンテーションの用語と定義」2021年4月11日取得