技術文書
技術文書は、製品、システム、またはサービスの使用、機能、またはアーキテクチャを (技術言語で)説明するために作成された情報のクラスを表す一般的な用語です。
技術文書のクラス
技術文書のクラスには次のものがあります:
- 特許
- 品目または部品/材料の仕様
- 品目または部品/材料のデータシート
- 試験方法
- 製造基準
- システム要件
- システムアーキテクチャ
- システム開発、テスト、製造、運用、保守に必要なシステム設計文書およびデータ
技術文書の標準化
歴史的に、ほとんどの技術文書のクラスは、形式、内容、構造に関して普遍的な適合性(標準)を欠いていました。国際標準化機構(ISO)などの団体を通じて、これを是正するための標準が開発されています。ISOは、技術製品文書のユーザーガイド、マニュアル、製品仕様などの作成規則に関する標準を発行しています。これらの標準は、ICS 01.110でカバーされています。 [1] ICS 01.110でカバーされていない技術製品文書は、以下のサブセクションにリストされています。
分野別
EU医療機器規制
EU医療機器規制に従う医療機器には、技術文書も必要です。規制の付属書II「技術文書」および付属書III「市販後調査に関する技術文書」には、医療機器の技術文書の内容が記載されています。これには、たとえば、機器の仕様、ラベルと説明書、設計と製造、安全性と性能の要件、リスク管理、臨床評価を含む機器の検証と検証に関する情報、および市販後調査からの情報が含まれます。
ソースデータの形式
ドキュメントのアーキテクチャと型付け
一部のドキュメンテーション システムは、ドキュメント セットを構成するドキュメントの全体的な種類や形式、およびドキュメントがどのように作成、公開、またはフォーマットされるか (またはむしろ) に関係しています。
例えば、Diátaxisフレームワーク(主にソフトウェアドキュメントの分野で使用されている[8])は、4つの異なるユーザーニーズに対応する4つの異なるドキュメント形式(チュートリアル、ハウツーガイド、リファレンス、説明)を想定しています。[9]対照的に、DITAは、タスク、コンセプト、リファレンス、用語集エントリ、トラブルシューティングの5つの異なる「トピックタイプ」を主張し、RedHatのモジュラードキュメントシステムは、コンセプト、手順、リファレンスの3つの「モジュール」を使用します。[10]
参照
引用
- ^ 「01.110: 技術製品ドキュメント」。国際標準化機構。 2009年6月10日閲覧。
- ^ 「ISO 15787:2001 技術製品文書 - 熱処理鉄部品 - 表示および表示」。国際標準化機構。 2009年6月10日閲覧。
- ^ 「ISO 3098-0:1997 技術製品ドキュメント - レター - パート0: 一般要求事項」。国際標準化機構。 2009年6月10日閲覧。
- ^ 「ISO 10209-1:1992 技術製品ドキュメント - 用語 - パート 1: 技術図面に関する用語: 図面の一般用語および種類」。国際標準化機構。2009年6 月 10 日閲覧。
- ^ 「ISO 2162-1:1993 技術製品ドキュメント - スプリング - パート 1: 簡略化された表現」。国際標準化機構。2009年6 月 10 日閲覧。
- ^ 「ISO 5457:1999 技術製品ドキュメント - 図面シートのサイズとレイアウト」。国際標準化機構。 2009年6月10日閲覧。
- ^ ISO6433技術製品ドキュメント。部品参照、BSI 英国規格、doi :10.3403/30203812 、 2020年12月16日取得
- ^ 「Diátaxis ドキュメント セットの部分リスト」 。2021年4 月 10 日閲覧。
- ^ 「Diátaxis文書フォームの概要」。2021年4月10日閲覧。
- ^ 「RedHat Modular Documentation の用語と定義」 。2021年4 月 11 日閲覧。