Разработка технической документации и технические писатели Технические писатели и разработка технической документации технические писатели в Телеграм 

 obmen_soobsheniyami.png Чат для технических писателей 
 Зарегистрируйтесь
Страницы: 1
RSS
Разработка рабочих инструкций, обсуждаем процесс разработки рабочих инструкций
 
Кто разрабатывал рабочие инструкции, давайте обсудим все тонкости их составления и разработки.  Привожу интересный пример:





Разработка рабочих инструкций по эксплуатации


Рис. 4. Разработка рабочих инструкций по эксплуатации
Действия по Разработке рабочих инструкций по эксплуатации
Цель процесса — создание руководства и конкретных, проверенных инструкций по выполнению эксплуатационных работ, определенных в плане операций. Для этого производятся следующие действия:
  • Выявление ресурсов.
  • Выявление документации по эксплуатации.
  • Разработка рабочих инструкций по эксплуатации.
  • Тестирование рабочих инструкций по эксплуатации.
Подробное описание действий представлено в следующей таблице.
Таблица 5. Действия и основные аспекты разработки рабочих инструкций по эксплуатации

Действия

Аспекты

Выявление ресурсов

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

Выявление документации по эксплуатации

Основные вопросы
  • Можно ли использовать информацию от поставщика при составлении рабочих инструкций?
  • Доступна ли уже существующая документация по эксплуатации?
  • Какими еще материалами по эксплуатации располагает ИТ-подразделение?
  • Есть ли недокументированные задачи или инструкции? Кто за них отвечает?
Входные данные
  • План операций
  • Документация по эксплуатации
  • Передовые методы и технические документы
  • Документы с описанием архитектуры и дизайна
  • Документация с описанием конфигурации
  • Специалисты по эксплуатации ИТ
  • Руководства к используемым средствам для управления эксплуатацией
Конечный результат
  • Информация, которая может лечь в основу перечня рабочих инструкций
Рекомендация
  • Следите, чтобы люди не тратили время на создание того, что уже и так существует.

Разработка рабочих инструкций по эксплуатации

Основные вопросы
  • Каким уровнем знаний обладают пользователи? Насколько подробными должны быть рабочие инструкции?
  • Какой метод предоставления инструкций (документ, портал и т. п.) будет наиболее эффективным и удобным для пользователей?
  • Какая информация должна сопровождать рабочие инструкции (активация, длительность, средства, учетные данные, роль пользователя)?
  • На каком языке должны быть написаны рабочие инструкции (английский, русский и пр.)?
  • Как привести рабочие инструкции в соответствие с требованиями плана операций?
Входные данные
  • План операций
  • Собранные материалы по эксплуатации
  • Информация и рекомендации профильных экспертов
Конечный результат
  • Конкретное и удобное руководство по выполнению работ, описанных в плане операций
Рекомендации
  • Выработайте стандартный шаблон и формат для рабочих инструкций.
  • Предоставляйте инструкции в удобном для пользователей виде (например, упорядочивайте их по ролям).

Тестирование рабочих инструкций по эксплуатации

Основные вопросы
  • Каковы критерии тестирования?
  • Понятна ли пользователям каждая инструкция в отдельности?
  • Приводит ли выполнение каждой инструкции к желаемому результату?
  • Ведет ли тестирование рабочих инструкций к соблюдению эксплуатационных требований?
Входные данные
  • Инструкции для эксплуатационных работ, перечисленных в плане операций
Конечные результаты
  • Тесты, удовлетворяющие критериям тестирования
  • Отзывы для сотрудника, который пишет рабочие инструкции
Рекомендация
  • Тестируйте инструкции в условиях, максимально напоминающих реальную рабочую среду.
Страницы: 1
Читают тему