ドキュメント

ドキュメンテーションとは、部品、組み立て、設置、保守、使用など、オブジェクト、システム、または手順のいくつかの属性に関して説明、解説、または指示するために使用される伝達可能な資料です。^[1]知識管理および知識組織化の一形態として、ドキュメンテーションは紙、オンライン、またはオーディオテープやCDなどのデジタルまたはアナログメディアで提供できます。例としては、ユーザーガイド、ホワイトペーパー、オンラインヘルプ、クイックリファレンスガイドなどがあります。紙またはハードコピーのドキュメンテーションはあまり一般的ではなくなりました。^[要出典]ドキュメンテーションは、Webサイト、ソフトウェア製品、およびその他のオンラインアプリケーションを介して配布されることがよくあります。

指導教材としてのドキュメンテーションは、情報の記録と検索を研究する ドキュメンテーション科学と混同しないでください。

関連する国際標準化機構（ISO）規格は公開されていませんが、このトピックに関する他の情報源からのガイドが目的を果たす可能性があります。^{[2] [3] [4] [5]}

文書作成には、文書の草稿作成、書式設定、提出、レビュー、承認、配布、再投稿、追跡などが含まれる場合があり、規制業界の関連する標準操作手順によって召集されます。また、コンテンツを一から作成する場合もあります。文書は読みやすく理解しやすいものでなければなりません。長すぎたり言葉が多すぎたりすると、誤解されたり無視されたりする可能性があります。明確で簡潔な言葉を使用し、文章は最大 15 語に制限する必要があります。一般向けの文書では、性別に特有の用語や文化的偏見を避ける必要があります。一連の手順では、ステップに明確な番号を付ける必要があります。^{[6] [7] [8] [9]}

テクニカル ライターとコーポレート コミュニケーターは、ドキュメンテーションを専門とする専門家です。理想的には、テクニカル ライターは主題だけでなく、執筆、コンテンツ管理、情報アーキテクチャの両方のバックグラウンドを持っています。テクニカル ライターは、エンジニア、技術専門家、医療専門家などの主題の専門家と協力して、ユーザーのニーズを満たすドキュメントを定義し、作成することがよくあります。コーポレートコミュニケーションには、次のような他の種類の文書化されたドキュメントが含まれます。

• 市場コミュニケーション (MarCom): MarCom ライターは、さまざまな印刷物、電子メディア、ソーシャル メディアを通じて、会社の価値提案を伝えようとします。企業ライティングのこの分野では、提案への対応に携わることがよくあります。
• テクニカル コミュニケーション(TechCom): テクニカル ライターは、会社の製品またはサービスに関する文書を作成します。技術出版物には、ユーザー ガイド、インストールおよび構成マニュアル、トラブルシューティングおよび修復手順などが含まれます。
• 法律文書作成: このタイプの文書は、多くの場合、弁護士またはパラリーガルによって作成されます。
• コンプライアンス ドキュメント: このタイプのドキュメントは、安全性承認、課税、資金調達、技術承認など、あらゆる規制コンプライアンスのニーズに対応する標準的な操作手順を成文化したものです。
• 医療文書：この文書化の分野には、医療を提供する過程で発生した出来事をタイムリーに記録し検証することが含まれます。^[10]

一般的なソフトウェア ドキュメントの種類は次のとおりです。

• 提案依頼
• 要件/作業内容/ 作業範囲
• ソフトウェア設計と機能仕様
• システム設計と機能仕様
• 変更管理、エラーおよび機能強化の 追跡
• ユーザー受け入れテスト
• マニュアルページ

一般的なハードウェアおよびサービス ドキュメントの種類は次のとおりです。

• ネットワーク図
• ネットワークマップ
• IT システムのデータシート(サーバー、スイッチなど)
• サービスカタログとサービスポートフォリオ（情報技術インフラストラクチャライブラリ）

シミュレーション業界で作成される一般的なソフトウェア ドキュメントの種類は SDF です。組み込みの航空電子機器からフル モーション コントロール システム経由の 3D 地形データベースまで、シミュレータ用のソフトウェアを開発する場合、エンジニアはプロジェクトまたはモジュールの開発「ビルド」の詳細を記したノートブックを作成します。ドキュメントは、Wiki ページ、Microsoft Word ドキュメント、またはその他の環境になります。ドキュメントには、要件セクション、ソフトウェアの通信インターフェイスの詳細を記したインターフェイスセクションを含める必要があります。多くの場合、メモセクションは概念実証の詳細を記し、エラーと機能強化を追跡するために使用されます。最後に、ソフトウェアのテスト方法を文書化するテストセクションがあります。これは、クライアントの要件への適合を文書化します。その結果、ソフトウェアの設計方法、対象デバイスでのソフトウェアのビルドおよびインストール方法、および既知の欠陥と回避策の詳細な説明が得られます。このビルド ドキュメントにより、将来の開発者や保守担当者は、ソフトウェアをタイムリーに理解できるようになり、コードの変更やバグの検索のロードマップも提供されます。

これらのソフトウェアツールは、ネットワーク機器のデータを自動的に収集できます。データは、インベントリ用と構成情報用です。情報技術インフラストラクチャライブラリは、 IT担当者のすべての情報の基礎としてこのようなデータベースを作成することを要求しています。これは、ITドキュメントの基礎でもあります。例として、XIA構成があります。^[11]

「文書化」は犯罪データベースを作成するプロセスを指す用語として好まれている。例としては、国家テロ対策センターのテロリストIDデータマート環境、性犯罪者登録簿、ギャングデータベースなどがある。^[12]

幼児教育分野におけるドキュメンテーションとは、「子どもたちのアイディア、思考、疑問、世界についての理論に注目し、それを評価し、子どもたちの活動の痕跡（絵、子どもたちの活動の写真、子どもたちの言葉の書き起こし）を収集して、より広いコミュニティと共有すること」です。^[13]

したがって、文書化は、教育者の子どもに関する知識と学習を家族、他の協力者、さらには子ども自身に結び付けるために使用されるプロセスです。

文書化は、観察、考察、文書化、共有、対応という調査サイクルの不可欠な部分です。^[13]

教育ドキュメンテーションは、教師のドキュメンテーションの観点から言えば、「子どもの理解の変遷についての教師の物語」です。^[13]ステファニー・コックス・スアレスの著書「ドキュメンテーション - 視点を変える」によると、「教師は研究者とみなされ、ドキュメンテーションは子どもと大人の知識構築を支援する研究ツールです」。^[14]

教室でのドキュメンテーションにはさまざまなスタイルがあります。以下は、ドキュメンテーションによって研究や学習を可視化する方法の例です。

1. ドキュメンテーション パネル (プロジェクトまたはイベントに関する複数の写真と説明を含む掲示板のようなプレゼンテーション)。
2. 日誌（教室での遊びや学習を毎日記録するログ）
3. 子どもたちによって、または子どもたちと一緒に作成された記録（記録中に子どもたちを観察する場合、実際の記録では子どもの観察のレンズが使用されます）
4. 個人ポートフォリオ（各子供の発達を追跡し、強調するために使用される文書）
5. 電子文書（アプリやデバイスを使用して家族や共同作業者と文書を共有する）
6. 会話の書き起こしまたは録音（記録に録音を使用すると、教育者と子どもの両方にとってより深い反省をもたらすことができます）
7. 学習ストーリー（「学習を説明し、子供たちが自分自身を強力な学習者として認識できるようにするために使われる物語」^[13]）
8. 教室の記録（教室の物理的環境の反映と記録）。^[13]

ドキュメンテーションは、それ自体がプロセスであることは間違いありませんが、教育者自身にとってもプロセスです。以下は、教育者自身にとって、また教育者自身にとって、ドキュメンテーションが進むにつれて進む発展です。

• 文書化の習慣を身につける
• 活動を公に語ることに抵抗がなくなる
• 視覚的リテラシースキルを養う
• 学習スタイルを可視化することとしての文書化の目的を概念化し、
• 解釈の目的とカリキュラムのさらなる設計のために目に見える理論を共有する。^[15]

無料辞書の Wiktionary でドキュメントを検索します。

• IEEEプロフェッショナルコミュニケーション協会
• Linux 情報プロジェクト (LINFO) によるドキュメント定義
• 情報とドキュメント 選択されたツールのリスト
• ドキュメントに関する記事のライブラリ: 技術文書とドキュメントに関する記事 2010 年 4 月 18 日、Wayback Machineにアーカイブ
• アイルランドの運転免許証、情報および書類