Документация
-
Определение и виды документации
- Документация — это материал, описывающий атрибуты объектов, систем и процедур.
- Может быть представлена на бумаге, онлайн или на цифровых носителях.
- Включает руководства пользователя, технические документы и краткие справочники.
-
Роль документации в управлении знаниями
- Документация помогает управлять знаниями и информацией.
- Не следует путать с документоведением.
-
Разработка и принципы составления документации
- Разработка документации включает в себя создание проекта, форматирование и утверждение.
- Должна быть простой для понимания и не содержать многословных предложений.
- Избегать гендерных терминов и культурных предубеждений в текстах.
- Этапы процедур должны быть четко пронумерованы.
-
Подготовка документации
- Технические писатели и специалисты по корпоративным коммуникациям занимаются подготовкой документации.
- Технические писатели сотрудничают с экспертами в различных областях.
- Документация должна соответствовать потребностям пользователя.
-
Типы документации
- Включает запросы предложений, технические задания, спецификации, управление изменениями и приемочное тестирование.
- В сфере моделирования используется SDF (инструмент «Папка документации по программному обеспечению»).
-
Документация в уголовном правосудии и дошкольном образовании
- В уголовном правосудии документация включает базы данных криминальных данных.
- В дошкольном образовании документирование — это сбор и сохранение идей и теорий детей.
-
Разработка документации
- Включает формирование привычек ведения документации, развитие навыков визуальной грамотности и публичное выступление.
-
Дополнительные ресурсы
- Ссылки на авторство, библиографический контроль, контроль за изменениями и другие связанные темы.