Войти
Документация - это любой передаваемый материал, который используется для описания, объяснения или инструктирования относительно некоторых атрибутов объекта, системы или процедуры, таких как его части, сборка, установка, обслуживание и использование. Документация может быть представлена на бумаге, в Интернете, на цифровых или аналоговых носителях, таких как аудиокассеты или компакт-диски. Примерами являются руководства пользователя, официальные документы, интерактивная справка и краткие справочные руководства. Бумага или печатная документация стала менее распространенной. Documentat ion часто распространяется через веб-сайты, программные продукты и другие онлайн-приложения.
Документацию как набор учебных материалов не следует путать с наукой о документации, изучением записи и поиска информации.
Хотя связанные стандарты ISO не являются общедоступными, для этой цели может служить руководство из других источников по этой теме. Дэвид Бергер представил несколько принципов написания документов, включая терминологию, нумерацию процедур и длину предложений.
Процедуры документации различаются от одного сектора или одного типа к другому.. Как правило, они могут включать в себя составление, форматирование, отправку, проверку, утверждение, распространение, повторную публикацию и отслеживание документов и т. Д. И выполняются соответствующими СОП в регулирующей отрасли. Это также может включать создание контента с нуля. Документация должна быть удобной для чтения и понимания. Если он слишком длинный и многословный, его могут неправильно понять или проигнорировать. Следует использовать четкие, краткие слова, а предложения должны быть ограничены максимум 15 словами. В документации, предназначенной для широкой аудитории, следует избегать гендерных терминов и культурных предубеждений. В серии процедур шаги должны быть четко пронумерованы.
Технические писатели и корпоративные коммуникаторы - профессионалы, чья сфера деятельности и работа - документация. В идеале технические писатели должны иметь опыт как в предметной области, так и в написании, управлении контентом и информационной архитектуре. Технические писатели чаще сотрудничают с профильными экспертами (SME), такими как инженеры, технические эксперты, медицинские работники или другие типы клиентов, чтобы определить, а затем создать документацию, отвечающую потребностям пользователя. Корпоративные коммуникации включают другие типы письменной документации, необходимые для большинства компаний.
Ниже приведены типичные типы документации по программному обеспечению:
Ниже приведены типичные типы документации по оборудованию и сервису:
Для создания документации используется множество типов программного обеспечения и приложений.
SDF является распространенным типом программного документа, написанного инженерами-программистами в индустрии моделирования. При разработке программного обеспечения для симулятора, которое может варьироваться от встроенных устройств авионики до трехмерных баз данных местности посредством систем полного управления движением, инженер ведет блокнот, в котором подробно описывается разработка «сборки» проекта или модуля. Документ может быть вики-страницей, документом MS Word или другой средой. Они должны содержать раздел требований, раздел интерфейса, в котором подробно описывается интерфейс связи программного обеспечения. Часто раздел примечаний используется для подробного подтверждения концепции, а затем для отслеживания ошибок и улучшений. Наконец, раздел тестирования, чтобы задокументировать, как было протестировано программное обеспечение. Это документальное соответствие требованиям клиента. Результатом является подробное описание того, как разработано программное обеспечение, как собрать и установить программное обеспечение на целевом устройстве, а также любые известные дефекты и обходные пути. Этот документ сборки позволяет будущим разработчикам и специалистам по сопровождению своевременно приступить к работе над программным обеспечением, а также предоставляет дорожную карту для изменения кода или поиска ошибок.
Эти программные инструменты могут автоматически собирать данные о вашем сетевом оборудовании. Данные могут быть для инвентаризации и для информации о конфигурации. Библиотека ITIL запрашивает создание такой базы данных в качестве основы для всей информации для ответственных ИТ-специалистов. Это также основа для ИТ-документации. Примеры включают конфигурацию XIA.
«Документация» - предпочтительный термин для процесса заполнения криминальных баз данных. Примеры включают Национальный контртеррористический центр Terrorist Identities Datamart Environment («TIDE»), реестры сексуальных преступников и базы данных банд.
Документация, относящаяся к области дошкольного образования, - это «когда мы замечаем и ценим детские идеи, мышление, вопросы и теории о мире, а затем собираем следы их работа (рисунки, фотографии детей в действии и расшифровки их слов), чтобы поделиться с более широким сообществом »
Таким образом, документирование - это процесс, используемый для связи знаний педагога и обучения ребенка / детей с семьями, другими сотрудниками и даже с самими детьми.
Документация является неотъемлемой частью цикла исследования - наблюдения, размышления, документирования, обмена и ответа.
Педагогическая документация, с точки зрения документации учителя, - это "рассказ учителя о движение в детском понимании ". По словам Стефани Кокс Суарес в «Документации - трансформируя наши перспективы», «учителя считаются исследователями, а документация - это инструмент исследования, способствующий развитию знаний среди детей и взрослых»
Документация может принимать различные стили в классе. Ниже приведены примеры способов, с помощью которых документация может сделать «исследование» или обучение видимым:
Документирование, безусловно, является процессом сам по себе, и это также процесс внутри преподавателя. Ниже приводится разработка документации по мере ее продвижения для самого преподавателя и внутри него:
.
 | Найдите документацию в Wiktionary, бесплатном словаре. |
