Документация - Documentation

Руководство по использованию документации в шаблонах Википедии см. {{документация}}

Документация - это любой передаваемый материал, который используется для описания, объяснения или инструктирования относительно некоторых атрибутов объекта, системы или процедуры, таких как его части, сборка, установка, обслуживание и использование.[1] Документация может быть предоставлена ​​на бумаге, в Интернете, на цифровых или аналоговых носителях, таких как аудиокассеты или компакт-диски. Примерами являются руководства пользователя, официальные документы, интерактивная справка и краткие справочные руководства. Бумажная или бумажная документация стала менее распространенной.[нужна цитата ] Документация часто распространяется через веб-сайты, программные продукты и другие онлайн-приложения.

Документацию как набор учебных материалов не следует путать с наука о документации, исследование записи и поиска информации.

Принципы составления документации

Пока связаны ISO Стандарты недоступны в открытом доступе, для этой цели может пригодиться руководство из других источников по этой теме.[2],[3],[4] Дэвид Бергер представил несколько принципов написания документов, включая терминологию, нумерацию процедур и длину предложения.[5]

Процедуры и методы

Процедуры документации различаются от одного сектора или одного типа к другому. Как правило, они могут включать в себя составление, форматирование, отправку, проверку, утверждение, распространение, повторную публикацию и отслеживание документов и т. Д., И созываются соответствующими СОПы в регулирующей отрасли. Это также может включать создание контента с нуля. Документация должна быть удобной для чтения и понимания. Если он слишком длинный и многословный, его могут неправильно понять или проигнорировать. Следует использовать четкие, краткие слова, а предложения должны быть ограничены максимум 15 словами. В документации, предназначенной для широкой аудитории, следует избегать гендерных терминов и культурных предубеждений. В серии процедур шаги должны быть четко пронумерованы.[6],[7],[8],[9]

Изготовление документации

Технические писатели а корпоративные коммуникаторы - это профессионалы, чья сфера деятельности и работа - документация. В идеале технические писатели имеют опыт как в предметной области, так и в написании, управлении контентом и информационной архитектуре. Технические писатели чаще сотрудничают с профильными экспертами (SME), такими как инженеры, технические эксперты, медицинские работники или другие типы клиентов, чтобы определить, а затем создать документацию, отвечающую потребностям пользователя. Корпоративные связи включает другие типы письменной документации, которые требуются для большинства компаний.

Специализированные области документации

  • Рыночные коммуникации (MarCom): Авторы MarCom стремятся донести ценностное предложение компании через различные печатные, электронные и социальные сети. Эта область корпоративного письма часто связана с ответами на предложения.
  • Техническая коммуникация (TechCom): Технические писатели документируют продукт или услугу компании. Технические публикации могут включать руководства пользователя, руководства по установке и настройке, а также процедуры устранения неполадок и ремонта.
  • Юридическое письмо: Этот тип документации часто готовят юристы или помощники юристов.
  • Документация о соответствии: этот тип документации кодифицирует Стандартные рабочие процедуры (СОП), для любых требований соответствия нормативным требованиям, например, для утверждения безопасности, налогообложения, финансирования, технического утверждения и всего
  • Медицинская документация: эта область документации включает в себя своевременную регистрацию и подтверждение событий, которые произошли в ходе оказания медицинской помощи.[10]

Документация по информатике

Основная статья: Документация по программному обеспечению

Ниже приведены типичные типы документации по программному обеспечению:

Ниже приведены типичные типы аппаратной и сервисной документации:

Инструменты для документирования ПО

Для создания документации используется множество типов программного обеспечения и приложений.

Папка документации по программному обеспечению (SDF)

SDF - распространенный тип программного документа, написанного разработчиками программного обеспечения в индустрии моделирования. При разработке программного обеспечения для симулятора, которое может варьироваться от встроенных устройств авионики до трехмерных баз данных местности посредством систем полного управления движением, инженер ведет блокнот, в котором подробно описывается разработка «сборки» проекта или модуля. Документ может быть вики-страницей, документом MS Word или другой средой. Они должны содержать требования раздел, интерфейс раздел для подробного описания коммуникационного интерфейса программного обеспечения. Часто заметки Раздел используется для подробного подтверждения концепции, а затем для отслеживания ошибок и улучшений. Наконец, тестирование раздел, чтобы задокументировать, как было протестировано программное обеспечение. Это документальное соответствие требованиям клиента. Результатом является подробное описание того, как разработано программное обеспечение, как собрать и установить программное обеспечение на целевом устройстве, а также любые известные дефекты и обходные пути. Этот документ сборки позволяет будущим разработчикам и специалистам по сопровождению своевременно приступить к работе над программным обеспечением, а также предоставляет дорожную карту для изменения кода или поиска ошибок.

Программное обеспечение для инвентаризации и настройки сети

Эти программные инструменты могут автоматически собирать данные о вашем сетевом оборудовании. Данные могут быть для инвентаризации и для информации о конфигурации. В Библиотека ITIL запросы на создание такой базы данных в качестве основы для всей информации для ответственных ИТ-специалистов. Это также основа для ИТ-документации. Примеры включают конфигурацию XIA.[11]

Документация в уголовном правосудии

«Документация» - предпочтительный термин для процесса заполнения криминальных баз данных. Примеры включают Национальный контртеррористический центр с Terrorist Identities Datamart Environment ("ПРИЛИВ"), реестры сексуальных преступников, и базы данных банд.[12]

Документация в дошкольном образовании

Документация, относящаяся к области дошкольного образования, - это «когда мы замечаем и ценим детские идеи, мышление, вопросы и теории о мире, а затем собираем следы их работы (рисунки, фотографии детей в действии и стенограммы их слов), чтобы поделиться с более широким сообществом "[13]

Таким образом, документирование - это процесс, используемый для того, чтобы связать знания педагога и обучение ребенка / детей с семьями, другими сотрудниками и даже с самими детьми.

Документация является неотъемлемой частью цикла исследования - наблюдения, размышления, документирования, обмена и ответа.[13]

Педагогическая документация, с точки зрения документации учителя, - это «рассказ учителя о движении в понимании детей».[13] Согласно Стефани Кокс Суарес в книге «Документация - трансформируя наши перспективы», «учителя считаются исследователями, а документация - это инструмент исследования, способствующий развитию знаний среди детей и взрослых»[14]

Документация может принимать разные стили в классе. Ниже приведены примеры того, как документация может сделать «исследование» или обучение видимым:

  1. Панели документации (презентация в виде доски объявлений с множеством изображений и описаний проекта или мероприятия).
  2. Ежедневный журнал (журнал, который ведется каждый день и фиксирует игру и обучение в классе)
  3. Документация, разработанная детьми или вместе с ними (при наблюдении за детьми во время документирования в реальной документации используется детская линза наблюдения)
  4. Индивидуальные портфолио (документация, используемая для отслеживания и выделения развития каждого ребенка)
  5. Электронная документация (использование приложений и устройств для обмена документацией с семьями и соавторами)
  6. Стенограммы или записи разговоров (использование записи в документации может вызвать более глубокие размышления как у педагога, так и у ребенка)
  7. Обучающие истории (рассказ, используемый для «описания обучения и помощи детям в понимании себя как сильных учеников»)[13])
  8. Класс как документация (отражение и документирование физической среды в классе).[13]

Документирование - это, конечно, процесс сам по себе, и это также процесс внутри преподавателя. Ниже приводится процесс разработки документации для самого преподавателя и внутри него:

  • Развивать (и) привычки к документации
  • Принять участие в публичном сообщении о деятельности
  • Развивать навыки визуальной грамотности
  • Осмыслять цель документации как сделать видимыми стили обучения, и
  • Делитесь видимыми теориями для интерпретации и дальнейшего развития учебной программы.[15]

Смотрите также


использованная литература

  1. ^ «Определение документации Информационного проекта Linux». www.linfo.org. Получено 9 августа 2020.
  2. ^ Н / Д (2003). «Путеводитель по документации» (PDF). Архивировано из оригинал (PDF) 29 июля 2007 г.
  3. ^ CGRP. «Руководство по стилям документации» (PDF). Получено 12 июн 2009.
  4. ^ Нет данных. «Путеводитель по документации MLA» (PDF). Архивировано из оригинал (PDF) 2 сентября 2006 г.. Получено 12 июн 2009.
  5. ^ Бергер, Дэвид. «Процедуры и документация» (PDF). Архивировано из оригинал (PDF) 27 июля 2011 г.. Получено 15 июн 2009.
  6. ^ Кроппер, Марк; Тони Диббенс (2002). «Процедуры документации GAIA-RVS» (PDF). Архивировано из оригинал (PDF) 2 ноября 2005 г.. Получено 15 июн 2009.
  7. ^ Нет данных. «Процедуры проверки и отслеживания документации системы качества GLNPO» (PDF). Архивировано из оригинал (PDF) 4 декабря 2008 г.. Получено 15 июн 2009.
  8. ^ Архив данных Великобритании (2009 г.). «Руководства по процессам обработки данных: процедуры обработки документации» (PDF). Архивировано из оригинал (PDF) 13 июня 2010 г.. Получено 15 июн 2009.
  9. ^ Архив данных Великобритании. «Руководства по процессам Data Services: методы обработки документации» (PDF). Получено 15 июн 2009.[мертвая ссылка ]
  10. ^ Springhouse (2008). Полное руководство по документации. п. ix. ISBN  9781582555560. Получено 12 июн 2009.
  11. ^ «Инструмент сетевой документации конфигурации XIA». Получено 8 августа 2017.
  12. ^ Рейдер Браун, Ребекка (2009). «Банда здесь: оценка необходимости национальной базы данных по бандам». Колумбийский журнал права и социальных проблем. 42: 293–333.
  13. ^ а б c d е Сьюзан, Стейси (11 мая 2015 г.). Педагогическая документация в раннем детстве: делимся опытом детей и мышлением учителей. Сент-Пол, Миннесота. ISBN  9781605543925. OCLC  909907917.
  14. ^ «Документация: трансформируя наши перспективы | Project Zero». www.pz.harvard.edu. Получено 26 октября 2018.
  15. ^ "ЕКРП. Том 13 № 2". ecrp.uiuc.edu. Получено 26 октября 2018.

внешние ссылки