ドキュメンテーション

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

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

教材のセットとしてのドキュメンテーションは、ドキュメンテーション科学、情報の記録と検索の研究と混同されるべきではありません。

ドキュメントを作成するための原則

関連するISO規格は簡単に公開することはできませんが、このトピックに関する他のソースからのガイドが目的に役立つ場合があります。[2]、[3]、[4] [5]

ドキュメントの作成には、ドキュメントの製図、フォーマット、提出、レビュー、承認、配布、再投稿、追跡などが含まれる場合があり、規制業界の関連するSOPによって召集されます。また、コンテンツを最初から作成することも含まれます。ドキュメントは読みやすく、理解しやすいものでなければなりません。長すぎて言葉が多すぎると、誤解されたり無視されたりする可能性があります。明確で簡潔な単語を使用する必要があり、文は最大15単語に制限する必要があります。一般の読者を対象とした文書は、性別固有の用語や文化的偏見を避ける必要があります。一連の手順では、ステップに明確な番号を付ける必要があります。[6]、[7]、[8]、[9]

ドキュメントの作成

テクニカルライターと企業コミュニケーターは、その分野と仕事がドキュメンテーションである専門家です。理想的には、テクニカルライターは、主題と、コンテンツの作成、管理、および情報アーキテクチャの両方のバックグラウンドを持っています。テクニカルライターは、エンジニア、技術専門家、医療専門家などの対象分野の専門家（SME）と協力して、ユーザーのニーズを満たすドキュメントを定義および作成するのが一般的です。コーポレートコミュニケーションには、次のような他の種類の文書が含まれます。

  • マーケットコミュニケーション（MarCom）：MarComのライターは、さまざまな印刷物、電子メディア、ソーシャルメディアを通じて、会社の価値提案を伝えるよう努めています。企業の執筆のこの分野は、しばしば提案への対応に従事しています。
  • テクニカルコミュニケーション（TechCom）：テクニカルライターは会社の製品またはサービスを文書化します。技術資料には、ユーザーガイド、インストールと構成のマニュアル、トラブルシューティングと修復の手順が含まれます。
  • 法的な執筆：このタイプの文書は、多くの場合、弁護士またはパラリーガルによって作成されます。
  • コンプライアンスドキュメント：このタイプのドキュメントは、安全承認、課税、資金調達、技術承認など、規制コンプライアンスのニーズに対応する標準操作手順（SOP）を体系化したものです。
  • ヘルスケアのドキュメント：このドキュメントのフィールドには、ヘルスケアを提供する過程で発生したイベントのタイムリーな記録と検証が含まれます。[10]

コンピュータサイエンスのドキュメンテーション

タイプ

以下は、典型的なソフトウェアドキュメントタイプです。

以下は、一般的なハードウェアおよびサービスのドキュメントタイプです。

ソフトウェアドキュメンテーションフォルダ（SDF）ツール

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

ネットワークインベントリと構成のためのソフトウェアツール

これらのソフトウェアツールは、ネットワーク機器のデータを自動的に収集できます。データは、インベントリおよび構成情報用である可能性があります。ITILライブラリは、責任のあるITのすべての情報の基礎としてそのようなデータベースを作成することを要求します。これは、ITドキュメントの基礎でもあります。例には、XIA構成が含まれます。[11]

刑事司法の文書化

「ドキュメンテーション」は、犯罪データベースにデータを入力するプロセスの推奨用語です。例としては、国家テロ対策センターのテロリストIDデータマート環境（「TIDE」）、性犯罪者登録、ギャングデータベースなどがあります。[12]

幼児教育におけるドキュメンテーション

幼児教育の分野に関連するドキュメンテーションは、「私たちが世界についての子供たちの考え、思考、質問、理論に気づき、評価し、次に彼らの仕事の痕跡（図面、行動中の子供たちの写真、および写し）を収集するときです。彼らの言葉の）より広いコミュニティと共有するために」[13]

したがって、ドキュメンテーションは、教育者の子供/子供に関する知識と学習を、家族、他の協力者、さらには子供自身にリンクするために使用されるプロセスです。

文書化は、調査のサイクルの不可欠な部分です-観察、反映、文書化、共有、および応答。[13]

教師のドキュメンテーションの観点からの教育学的ドキュメンテーションは、「子供たちの理解における運動の教師の物語」です。[13]ステファニー・コックス・スアレスの「ドキュメンテーション-私たちの視点の変革」によると、「教師は研究者と見なされ、ドキュメンテーションは子供と大人の間の知識構築をサポートする研究ツールです」[14]

ドキュメントは、教室でさまざまなスタイルを取ることができます。以下は、ドキュメンテーションが「研究」または学習を可視化する方法を例示しています。

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

ドキュメンテーションは確かにそれ自体がプロセスであり、教育者内のプロセスでもあります。以下は、教育者自身のために、そして教育者自身の中で進行するドキュメントの開発です。

  • ドキュメントの習慣を身につける
  • 活動の再集計で上場することに慣れてください
  • 視覚リテラシースキルを開発する
  • 学習スタイルを可視化することとして文書化の目的を概念化し、
  • 解釈の目的とカリキュラムのさらなる設計のために目に見える理論を共有します。[15]

も参照してください


参考文献

  1. ^ 「Linux情報プロジェクトによるドキュメント定義」。www.linfo.org 。2020年8月9日取得。
  2. ^ 該当なし（2003）。「ドキュメントガイド」（PDF）。2007年7月29日にオリジナル（PDF）からアーカイブされました。
  3. ^ CGRP。「ドキュメントスタイルのガイド」（PDF）。2009年6月12日取得。
  4. ^ 該当なし。「MLAドキュメントのガイド」（PDF）。2006年9月2日にオリジナル（PDF）からアーカイブされました。2009年6月12日取得。
  5. ^ バーガー、デビッド。「手順と文書化」（PDF）。2011年7月27日にオリジナル（PDF）からアーカイブされました。2009年6月15日取得。
  6. ^ クロッパー、マーク; トニーディベンズ（2002）。「GAIA-RVS文書化手順」（PDF）。2005年11月2日にオリジナル（PDF）からアーカイブされました。2009年6月15日取得。
  7. ^ 該当なし。「GLNPOの品質システム文書のレビュー手順と追跡」（PDF）。2008年12月4日にオリジナル（PDF）からアーカイブされました。2009年6月15日取得。
  8. ^ UKデータアーカイブ（2009）。「データサービスプロセスガイド：ドキュメント処理手順」（PDF）。2010年6月13日にオリジナル（PDF）からアーカイブされました。2009年6月15日取得。
  9. ^ 英国のデータアーカイブ。「データサービスプロセスガイド：ドキュメント処理技術」（PDF）。2009年6月15日取得。 [デッドリンク]
  10. ^ スプリングハウス（2008）。ドキュメントの完全ガイド。p。ix。ISBN 9781582555560。2009年6月12日取得。
  11. ^ 「XIA構成ネットワークドキュメンテーションツール」。2017年8月8日取得。
  12. ^ Rader Brown、Rebecca（2009）。「ギャングのすべてがここにある：全国的なギャングデータベースの必要性の評価」。法と社会問題のコロンビアジャーナル。42：293–333。
  13. ^ a b c d e スーザン、ステイシー（2015年5月11日）。幼児期の教育学的文書：子供の学習と教師の思考を共有する。ミネソタ州セントポール。ISBN 9781605543925。OCLC909907917 。_
  14. ^ 「ドキュメンテーション：私たちの視点を変える|プロジェクトゼロ」。www.pz.harvard.edu 。2018年10月26日取得。
  15. ^ "ECRP。Vol13No2"。ecrp.uiuc.edu 。2018年10月26日取得。

外部リンク

Retrieved from "https://en.wikipedia.org/w/index.php?title=Documentation&oldid=1071574194"