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

редактировать

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

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

Содержание

  • 1 Принципы создания документации
    • 1.1 Процедуры и методы
  • 2 Создание документации
    • 2.1 Специализированные области документации
  • 3 Документация в области компьютерных наук
    • 3.1 Инструменты для документирования программного обеспечения
      • 3.1.1 Папка документации программного обеспечения (SDF)
      • 3.1.2 Программное обеспечение для инвентаризации и настройки сети
  • 4 Документация в области уголовного правосудия
  • 5 Документация в дошкольном образовании
  • 6 См. Также
  • 7 Ссылки
  • 8 Внешние ссылки

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

Хотя связанные стандарты ISO не являются общедоступными, для этой цели может служить руководство из других источников по этой теме. Дэвид Бергер представил несколько принципов написания документов, включая терминологию, нумерацию процедур и длину предложений.

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

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

Составление документации

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

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

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

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

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

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

Инструменты для документирования программного обеспечения

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  • Выработайте (и) привычки к документации
  • Научитесь (а) доводить до общественности, рассказывая о занятиях
  • Развивать навыки визуальной грамотности.
  • Осмыслять (-ые) цель документации как сделать видимыми стили обучения и
  • делиться (-ами) наглядными теориями для целей интерпретации и дальнейшего проектирования учебной программы.

См. Также

.

Ссылки

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

Найдите документацию в Wiktionary, бесплатном словаре.
Последняя правка сделана 2021-05-17 10:55:28
Содержание доступно по лицензии CC BY-SA 3.0 (если не указано иное).
Обратная связь: support@alphapedia.ru
Соглашение
О проекте