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