====== Как писать инструкции ======

==== Цель создания:Научить сотрудника самому создавать инструкции и сохранять полученный опыт в компании ====

Когда и зачем писать инструкции описано в [[http://zbt.company/как_пользоваться/регламент_написания_инструкций|Регламенте написания инструкций]]

===== Вопросы для раскрытия инструкции =====

==== (кол-во вопросов зависит от темы): ====

  * Что это? Чему учим? - Заголовок
  * Для чего нужно? Почему мы это описываем ? -блок информации
  * Кто делает?
  * Когда делается или происходит?
  * Как делать?
  * Какие виды бывают?
  * Чего не делать или что запрещается?
  * Технологии, материалы, принципы, программы
  * Какие частые ситуации, вопросы могут возникнуть с этим ?
  * Что важно еще знать из опыта или практики при работе с этим
  * Технические характеристики
  * Вложения: скриншоты, видео-записи, шаблоны файлов и документов

=====   Принцип инструкции:   =====

  * Писать простыми словами, не двусмысленно
  * Описание должно содержать всю необходимую информацию для полного раскрытия вопроса
  * Не повторять информацию из других инструкций
  * Форматировать текст
  * Прилагать скриншоты, видео-записи, шаблоны файлов и документов, если такие требуются.

=====   Какие бывают инструкции:   =====

  * Текстовые ([[https://docs.google.com/document/d/1Nuz5bcCZ9XgGw0VddPJZhdJRTZCeWnweg7xAUtl0Yy0/edit?usp=sharing|пример]])
  * Текст + скриншоты (добавить пример)
  * Скринкасты (съемка экрана с комментариями) (добавить пример)
  * Видеосъемка с комментариями (добавить пример)

=====   С помощью чего создаются инструкции:   =====

  * **Текстовые**  - пишутся в разделе Творческая мастерская Как создавать описано в [[http://zbt.company/как_пользоваться/регламент_написания_инструкций|Регламенте написания инструкций]].
  * **Скриншоты**  делаем с помощью JOXI ([[http://joxi.ru/|http://joxi.ru/]])
  * **Скринкасты**  записываем через FastStone Capture ([[http://faststonecapture.ru/|http://faststonecapture.ru/]]). Инструкция готовится.
  * **Видео**  записываем на телефон и отправляем через telegram или файлообменник.
==== Форматируем текст для удобства чтения и навигации: ====

  * Создавать новые абзацы, чтобы разделить логические блоки.
  * Разделять абзацы пробелами
  * Не использовать "но"
  * Запрещено начинать предложение с "если"
  * Жирным выделяем заголовки блоков

**Проверка текста**: Перед публикацией необходимо проверить текст на его чистоту и читаемость здесь: [[http://glvrd.ru/|http://glvrd.ru/]]

Хорошие тексты набирают от 8.5 баллов.

**Пример инструкции**: [[https://docs.google.com/document/d/1Nuz5bcCZ9XgGw0VddPJZhdJRTZCeWnweg7xAUtl0Yy0/edit?usp=sharing|СМОТРЕТЬ ПРИМЕР (пока неактулен, т.к. в gdocs)]]