ドキュメントとは、オブジェクト、システム、または手順の部品、組み立て、インストール、メンテナンス、使用方法などの属性について説明、解説、指示するために使用される、伝達可能な資料のことです。[ 1 ]知識管理および知識組織化の一形態として、ドキュメントは紙、オンライン、またはオーディオテープやCDなどのデジタルまたはアナログメディアで提供できます。このようなリソースの例としては、ユーザーガイド、ホワイトペーパー、オンラインヘルプ、クイックリファレンスガイドなどがあります。紙またはハードコピーのドキュメントはあまり一般的ではなくなりました。現代のドキュメントは、Webサイト、ソフトウェア製品、その他のオンラインアプリケーションを通じて配布されることがよくあります。
教育資料の集合体として理解されるドキュメンテーションは、情報の記録と検索を研究するドキュメンテーション科学と混同してはならない。
関連する国際標準化機構(ISO)規格は一般には容易に入手できませんが、このトピックに関する他の情報源からのガイドが役に立つかもしれません。[ 2 ] [ 3 ] [ 4 ] [ 5 ]
文書作成には、文書の起草、書式設定、提出、レビュー、承認、配布、再投稿、追跡などが含まれる場合があり、規制業界では関連する標準作業手順によって実施されます。ゼロからコンテンツを作成することもあります。文書は読みやすく理解しやすいものでなければなりません。長すぎたり、冗長すぎたりすると、誤解されたり無視されたりする可能性があります。明確で簡潔な言葉を使用し、文は最大 15 語に制限する必要があります。一般読者向けの文書では、性別固有の用語や文化的偏見を避ける必要があります。一連の手順では、ステップに明確な番号を付ける必要があります。[ 6 ] [ 7 ] [ 8 ] [ 9 ]
テクニカルライターとコーポレートコミュニケーターは、文書作成を専門とするプロフェッショナルです。理想的には、テクニカルライターは対象分野に関する知識と、執筆、コンテンツ管理、情報アーキテクチャに関する知識の両方を備えていることが望ましいです。テクニカルライターは、エンジニア、技術専門家、医療専門家など、対象分野の専門家と協力して、ユーザーのニーズを満たす文書を定義し、作成することが一般的です。コーポレートコミュニケーションには、以下のような他の種類の文書作成も含まれます。
以下は、一般的なソフトウェアドキュメントの種類です。
以下は、一般的なハードウェアおよびサービス関連のドキュメントの種類です。
シミュレーション業界でよく使われるソフトウェアドキュメントの一つに、SDF(ソフトウェア開発フレームワーク)があります。組み込み航空電子機器から3D地形データベース、そして完全なモーションコントロールシステムまで、シミュレーター用のソフトウェアを開発する際、エンジニアはプロジェクトやモジュールの開発過程(ビルド)を詳細に記録したノートを作成します。このドキュメントは、Wikiページ、Microsoft Word文書、その他の形式で作成できます。要件セクション、ソフトウェアの通信インターフェースを詳細に記述するインターフェースセクション、概念実証の詳細を記述し、エラーや機能強化を追跡するメモセクション、そしてソフトウェアのテスト方法を文書化するテストセクションが含まれます。テストセクションでは、クライアントの要件への適合性を確認します。結果として、ソフトウェアの設計方法、対象デバイスへのビルドとインストール方法、既知の不具合や回避策などを詳細に記述したドキュメントが作成されます。このビルドドキュメントにより、将来の開発者や保守担当者はソフトウェアを迅速に理解できるだけでなく、コードの変更やバグの探索のためのロードマップとしても活用できます。
これらのソフトウェアツールは、ネットワーク機器のデータを自動的に収集できます。データは、インベントリ情報や構成情報として使用できます。情報技術インフラストラクチャライブラリは、 IT担当者向けのすべての情報の基礎として、このようなデータベースを作成することを要求しています。これは、ITドキュメントの基礎にもなります。例としては、XIA構成があります。[ 11 ]
犯罪データベースに情報を入力するプロセスには、「文書化」という用語が好んで使われます。例としては、国家対テロセンターのテロリスト識別データマート環境、性犯罪者登録簿、ギャングデータベースなどがあります。[ 12 ]
幼児教育分野におけるドキュメンテーションとは、「子どもたちの世界に対する考え、思考、質問、理論に気づき、それを尊重し、子どもたちの作品の痕跡(絵、活動中の写真、言葉の書き起こし)を集めて、より広いコミュニティと共有すること」です。[ 13 ]このように、ドキュメンテーションは、教育者の知識と子どもの学びを家族、他の協力者、さらには子ども自身と結びつけるために使用されるプロセスです。ドキュメンテーションは、観察、振り返り、記録、共有、応答という探究のサイクルに不可欠な部分です。[ 13 ]教師のドキュメンテーションという観点から見た教育的ドキュメンテーションは、「子どもたちの理解の進展に関する教師の物語」です。[ 13 ] [ 14 ] Stephanie Cox Suarez は「Documentation - Transforming our Perspectives」の中で、「教師は研究者とみなされ、ドキュメンテーションは子どもと大人の間の知識構築を支援する研究ツールである」と述べています。[ 15 ]
教室での記録方法は多岐にわたります。以下に、記録によって研究や学習内容を可視化する方法の例を示します。
文書化はそれ自体が一つのプロセスであると同時に、教育者自身の内面におけるプロセスでもあります。以下は、教育者自身の中で、そして教育者のために文書化が進展していく過程を示したものです。
{{cite book}}: CS1メンテナンス: 場所の発行元が見つかりません (リンク)