Из Википедии, бесплатной энциклопедии
Перейти к навигации Перейти к поиску
Инструкции по использованию документации в шаблонах Википедии см. В {{ документации }}

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

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

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

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

Процедуры и методы [ править ]

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

Создание документации [ править ]

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

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

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

Документация по информатике [ править ]

Основная статья: Программная документация

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

  • Запрос предложений ( RFP )
  • Требования / Техническое задание / Объем работ (SOW)
  • Дизайн программного обеспечения и функциональные спецификации
  • Дизайн системы и функциональные характеристики
  • Управление изменениями, отслеживание ошибок и улучшений
  • Приемочное тестирование пользователей
  • Manpages

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

  • Схемы сети
  • Карты сети
  • Технический паспорт для ИТ-систем (например, сервер, коммутатор)
  • Каталог услуг и портфель услуг ( ITIL )

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

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

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

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

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

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

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

«Документация» - предпочтительный термин для процесса заполнения криминальных баз данных. Примеры включают в себя Национальный Антитеррористического центра «s Террорист идентичностей Datamart Environment („TIDE“), секс обидчика реестров и баз данных банды. [12]

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

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

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

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

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

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

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

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

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

См. Также [ править ]

  • Авторская
  • Библиографический контроль
  • Изменить управление
  • Указатель цитирования
  • Авторские права
  • Описание
  • Документ
  • Документация (поле)
  • Документация наука
  • Идентификатор документа
  • Система управления документами
  • Документальный
  • Свобода информации
  • Глоссарий
  • Исторический документ
  • Указатель (публикация)
  • ISO 2384: 1977
  • ISO 259: 1984
  • ISO 5123: 1984
  • ISO 3602: 1989
  • ISO 6357: 1985
  • ISO 690
  • ISO 5964
  • ISO 9001
  • IEC 61355
  • Международное стандартное библиографическое описание
  • Журнал документации
  • Лицензирование
  • Фирменный бланк
  • Список содержания
  • Техническая документация
  • Гид пользователя
  • Медицинский сертификат
  • Издательский
  • Ведение документации
  • Документация по программному обеспечению
  • Гид по стилю
  • Техническая коммуникация


Ссылки [ править ]

  1. ^ «Определение документации Информационного проекта Linux» . www.linfo.org . Дата обращения 9 августа 2020 .
  2. Перейти ↑ N / A (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. ^ Cropper, Марк; Тони Диббенс (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. ^ Архив данных Великобритании. «Руководства по процессам службы данных: методы обработки документации» (PDF) . Проверено 15 июня 2009 года . [ мертвая ссылка ]
  10. ^ Springhouse (2008). Полное руководство по документации . п. ix. ISBN 9781582555560. Проверено 12 июня 2009 года .
  11. ^ «Инструмент сетевой документации конфигурации XIA» . Проверено 8 августа 2017 года .
  12. ^ Рейдер Браун, Ребекка (2009). «Банда здесь: оценка потребности в национальной базе данных по бандам». Колумбийский журнал права и социальных проблем . 42 : 293–333.
  13. ^ a b c d e Сьюзан, Стейси (11 мая 2015 г.). Педагогическая документация в раннем детстве: разделение обучения детей и мышления учителей . Сент-Пол, Миннесота. ISBN 9781605543925. OCLC  909907917 .
  14. ^ «Документация: преобразование наших перспектив | Project Zero» . www.pz.harvard.edu . Проверено 26 октября 2018 года .
  15. ^ "ECRP. Том 13 № 2" . ecrp.uiuc.edu . Проверено 26 октября 2018 года .

Внешние ссылки [ править ]

  • IEEE Professional Communication Society
  • Определение документации Информационного проекта Linux (LINFO)
  • Информация и документация Список выбранных инструментов
  • Библиотека статей по документации: технические статьи и статьи по документации