Документация — это любой передаваемый материал, который используется для описания, объяснения или инструкций относительно некоторых атрибутов объекта, системы или процедуры, таких как его части, сборка, установка, обслуживание и использование. [1] В качестве формы управления знаниями и организации знаний документация может предоставляться на бумаге, в Интернете или на цифровых или аналоговых носителях , таких как аудиокассеты или компакт-диски . Примерами являются руководства пользователя , официальные документы , онлайн-справка и краткие справочные руководства. Бумажная или печатная документация стала менее распространенной. [ нужна ссылка ] Документация часто распространяется через веб-сайты, программные продукты и другие онлайн-приложения.
Документацию как набор учебных материалов не следует путать с документацией , изучением записи и извлечения информации.
Хотя соответствующие стандарты Международной организации по стандартизации (ISO) не являются общедоступными, для этой цели может служить руководство из других источников по этой теме. [2] [3] [4] [5]
Разработка документации может включать в себя составление документов, форматирование, представление, рассмотрение, утверждение, распространение, повторную публикацию и отслеживание и т. д. и проводится в соответствии с соответствующей стандартной рабочей процедурой в регулирующей отрасли. Это также может включать создание контента с нуля. Документация должна быть легко читаемой и понятной. Если оно слишком длинное и многословное, его могут неправильно понять или проигнорировать. Следует использовать ясные, краткие слова, а количество предложений должно быть ограничено максимум 15 словами. В документации, предназначенной для широкой аудитории, следует избегать гендерных терминов и культурных предубеждений. В серии процедур шаги должны быть четко пронумерованы. [6] [7] [8] [9]
Технические писатели и корпоративные коммуникаторы — это профессионалы, чья сфера деятельности — документация. В идеале технические писатели имеют опыт как в предметной области, так и в написании статей, управлении контентом и информационной архитектуре . Технические писатели чаще сотрудничают с профильными экспертами , такими как инженеры, технические эксперты, медицинские работники и т. д., чтобы определить, а затем создать документацию, отвечающую потребностям пользователя. Корпоративные коммуникации включают в себя и другие виды письменной документации, например:
Ниже приведены типичные типы документации по программному обеспечению:
Ниже приведены типичные типы аппаратной и сервисной документации:
Распространенным типом программного документа, написанного в индустрии моделирования, является SDF. При разработке программного обеспечения для симулятора, которое может варьироваться от встроенных устройств авионики до трехмерных баз данных местности и систем полного управления движением, инженер ведет блокнот, в котором подробно описывается разработка «сборки» проекта или модуля. Документ может представлять собой вики-страницу, документ Microsoft Word или другую среду. Они должны содержать раздел требований и раздел интерфейса , в котором подробно описывается коммуникационный интерфейс программного обеспечения. Часто раздел примечаний используется для подробного подтверждения концепции, а затем для отслеживания ошибок и улучшений. Наконец, раздел тестирования , в котором документируется, как тестировалось программное обеспечение. Это документально подтверждает соответствие требованиям клиента. Результатом является подробное описание того, как устроено программное обеспечение, как его собрать и установить на целевое устройство, а также все известные дефекты и обходные пути. Этот документ сборки позволяет будущим разработчикам и сопровождающим своевременно освоить программное обеспечение, а также предоставляет план действий по изменению кода или поиску ошибок.
Эти программные инструменты могут автоматически собирать данные вашего сетевого оборудования. Данные могут быть для инвентаризации и для информации о конфигурации. Библиотека инфраструктуры информационных технологий просит создать такую базу данных в качестве основы для всей информации для ответственных за ИТ. Это также основа ИТ-документации. Примеры включают конфигурацию XIA. [11]
«Документация» — предпочтительный термин для обозначения процесса заполнения криминальных баз данных. Примеры включают в себя среду сбора данных о личности террористов Национального контртеррористического центра , реестры сексуальных преступников и базы данных банд. [12]
Документация, относящаяся к области дошкольного образования, — это «когда мы замечаем и ценим идеи, мышление, вопросы и теории детей о мире, а затем собираем следы их работы (рисунки, фотографии детей в действии и стенограммы). их слов), чтобы поделиться с более широким сообществом». [13]
Таким образом, документирование – это процесс, используемый для связи знаний педагога и обучения ребенка/детей с семьями, другими сотрудниками и даже с самими детьми.
Документирование является неотъемлемой частью цикла исследования: наблюдение, размышление, документирование, обмен информацией и реагирование. [13]
Педагогическая документация, с точки зрения педагогической документации, представляет собой «рассказ учителя о движении в понимании детей». [13] По словам Стефани Кокс Суарес в книге «Документация – трансформация наших взглядов», «учителя считаются исследователями, а документация – это исследовательский инструмент, способствующий формированию знаний среди детей и взрослых». [14]
В классе документация может принимать самые разные стили. Ниже приведены примеры того, как документация может сделать исследование или обучение видимым:
Документирование, безусловно, является процессом само по себе, а также процессом внутри преподавателя. Ниже приводится разработка документации по мере ее продвижения для самого преподавателя:
{{cite book}}: CS1 maint: отсутствует местоположение издателя ( ссылка )