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

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

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

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

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

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

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

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

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

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

Типы [ править ]

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

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

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

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

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

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

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

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

«Документация» — предпочтительный термин для обозначения процесса заполнения криминальных баз данных. Примеры включают в себя Национального контртеррористического центра , среду хранения данных о личности террористов реестры сексуальных преступников и базы данных банд. ^[12]

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

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

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

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

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

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

Панели документации (презентация в виде доски объявлений с множеством изображений и описаний проекта или мероприятия).
Ежедневный журнал (журнал, который ведется каждый день и в котором фиксируются игры и обучение в классе)
Документация, разработанная детьми или совместно с ними (при наблюдении за детьми во время документирования в самой документации используется детская линза наблюдения)
Индивидуальные портфолио (документация, используемая для отслеживания и освещения развития каждого ребенка)
Электронная документация (использование приложений и устройств для обмена документацией с семьями и сотрудниками)
Стенограммы или записи разговоров (использование записи в документации может вызвать более глубокие размышления как у педагога, так и у ребенка)
Учебные истории (повествование, используемое для «описания обучения и помощи детям увидеть себя сильными учениками»). ^[13])
Класс как документация (отражения и документирование физической среды классной комнаты). ^[13]

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

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

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

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

^ «Определение документации The Linux Information Project» . www.linfo.org . Проверено 9 августа 2020 г.
^ «Руководство по документации» (PDF) . somers.k12.ct.us . 2003. Архивировано из оригинала (PDF) 29 июля 2007 года.
^ КГРП. «Руководство по стилям документации» (PDF) . Государственный университет Сан-Франциско . Архивировано из оригинала (PDF) 5 января 2011 года . Проверено 12 июня 2009 г.
^ «Руководство по документации MLA» (PDF) . sunyjcc . Архивировано из оригинала (PDF) 2 сентября 2006 года . Проверено 12 июня 2009 г.
^ Бергер, Дэвид. «Процедуры и документация» (PDF) . техническое обслуживаниеонлайн . Архивировано из оригинала (PDF) 27 июля 2011 года . Проверено 15 июня 2009 г.
^ Кроппер, Марк; Диббенс, Тони (2002). «Процедуры документирования GAIA-RVS» (PDF) . mssl.ucl.ac.uk. Архивировано из оригинала (PDF) 2 ноября 2005 года . Проверено 15 июня 2009 г.
^ «Процедуры проверки и отслеживания документации системы качества GLNPO» (PDF) . Агентство по охране окружающей среды США . Архивировано из оригинала (PDF) 4 декабря 2008 года . Проверено 15 июня 2009 г.
^ Архив данных Великобритании (2009 г.). «Руководства по процессам служб данных: процедуры обработки документации» (PDF) . esds.ac.uk. Архивировано из оригинала (PDF) 13 июня 2010 года . Проверено 15 июня 2009 г.
^ Архив данных Великобритании. «Руководства по процессам служб данных: методы обработки документации» (PDF) . Проверено 15 июня 2009 г. ^{[ мертвая ссылка ]}
^ Спрингхаус (2008). Полное руководство по документации . Липпинкотт Уильямс и Уилкинс. п. ix. ISBN 9781582555560 . Проверено 12 июня 2009 г.
^ «Инструмент документации сети конфигурации XIA» . ЦЕНТРЭЛ Решения . Проверено 8 августа 2017 г.
^ Рейдер Браун, Ребекка (2009). «Все банды здесь: оценка необходимости национальной базы данных о бандах». Колумбийский журнал права и социальных проблем . 42 : 293–333.
↑ Перейти обратно: Перейти обратно: ^а ^б ^с ^д ^и Сьюзен, Стейси (11 мая 2015 г.). Педагогическая документация в раннем детстве: обмен знаниями детей и мышлением учителей . Сент-Пол, Миннесота. ISBN 9781605543925 . OCLC 909907917 . {{cite book}}: CS1 maint: отсутствует местоположение издателя ( ссылка )
^ Ривард, Мелисса. «Документация: трансформируя наши перспективы | Проект Ноль» . www.pz.harvard.edu . Проверено 26 октября 2018 г.
^ «ЕКРП. Том 13 № 2» . ecrp.uiuc.edu . Архивировано из оригинала 27 октября 2018 года . Проверено 26 октября 2018 г.

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

Определение документации The Linux Information Project (LINFO)
Библиотека статей по документации: Технические статьи и статьи по документации. Архивировано 18 апреля 2010 г. на Wayback Machine.

[1] «Определение документации The Linux Information Project» . www.linfo.org . Проверено 9 августа 2020 г.

[agd-2] «Руководство по документации» (PDF) . somers.k12.ct.us . 2003. Архивировано из оригинала (PDF) 29 июля 2007 года.

[agds-3] КГРП. «Руководство по стилям документации» (PDF) . Государственный университет Сан-Франциско . Архивировано из оригинала (PDF) 5 января 2011 года . Проверено 12 июня 2009 г.

[agmd-4] «Руководство по документации MLA» (PDF) . sunyjcc . Архивировано из оригинала (PDF) 2 сентября 2006 года . Проверено 12 июня 2009 г.

[pad-5] Бергер, Дэвид. «Процедуры и документация» (PDF) . техническое обслуживаниеонлайн . Архивировано из оригинала (PDF) 27 июля 2011 года . Проверено 15 июня 2009 г.

[grdp-6] Кроппер, Марк; Диббенс, Тони (2002). «Процедуры документирования GAIA-RVS» (PDF) . mssl.ucl.ac.uk. Архивировано из оригинала (PDF) 2 ноября 2005 года . Проверено 15 июня 2009 г.

[gqsd-7] «Процедуры проверки и отслеживания документации системы качества GLNPO» (PDF) . Агентство по охране окружающей среды США . Архивировано из оригинала (PDF) 4 декабря 2008 года . Проверено 15 июня 2009 г.

[dspg-8] Архив данных Великобритании (2009 г.). «Руководства по процессам служб данных: процедуры обработки документации» (PDF) . esds.ac.uk. Архивировано из оригинала (PDF) 13 июня 2010 года . Проверено 15 июня 2009 г.

[dspg2-9] Архив данных Великобритании. «Руководства по процессам служб данных: методы обработки документации» (PDF) . Проверено 15 июня 2009 г. ^{[ мертвая ссылка ]}

[cgd2-10] Спрингхаус (2008). Полное руководство по документации . Липпинкотт Уильямс и Уилкинс. п. ix. ISBN 9781582555560 . Проверено 12 июня 2009 г.

[11] «Инструмент документации сети конфигурации XIA» . ЦЕНТРЭЛ Решения . Проверено 8 августа 2017 г.

[12] Рейдер Браун, Ребекка (2009). «Все банды здесь: оценка необходимости национальной базы данных о бандах». Колумбийский журнал права и социальных проблем . 42 : 293–333.

[:0-13] Перейти обратно: Перейти обратно: ^а ^б ^с ^д ^и Сьюзен, Стейси (11 мая 2015 г.). Педагогическая документация в раннем детстве: обмен знаниями детей и мышлением учителей . Сент-Пол, Миннесота. ISBN 9781605543925 . OCLC 909907917 . {{cite book}}: CS1 maint: отсутствует местоположение издателя ( ссылка )

[:1-14] Ривард, Мелисса. «Документация: трансформируя наши перспективы | Проект Ноль» . www.pz.harvard.edu . Проверено 26 октября 2018 г.

[:2-15] «ЕКРП. Том 13 № 2» . ecrp.uiuc.edu . Архивировано из оригинала 27 октября 2018 года . Проверено 26 октября 2018 г.

[1]

[2]

[3]

[4]

[5]

[6]

[7]

[8]

[9]

[10]

[11]

[12]

[13]

[14]

[15]