Важная часть работы специалиста по внедрению PLM и не только. Хорошая инструкция или стандарт (СТО) на вес золота. Понятно написал, меньше будет вопросов, меньше нагрузка на техподдержку - профит очевиден)

По жизни мне попадались разные инструкции пользователя: 🔪Техкарты для вертолёта, на которых если и были картинки, то ужасные и непонятные

🔪СТО по проектированию и моделированию, где не всегда были картинки.

🔪Инструкция по обслуживанию велосипедной вилки Rock Shox, которая просто покорила моё сердце❤️ (см. Рисунок 1 - 2)

Мне надо было перебрать вилку, я скачал инструкцию, купил то, что в ней сказано и принялся за дело. Это был мой первый раз, и я вилку перебрал удачно (хотя я тот еще рукожоп) Воруй как художник, поэтому некоторые вещи я захотел добавить в свои инструкции уже по основной работе.

Основные требования к текстовым документам изложены в ГОСТ 2.105, пересказывать смысла нет.

Как сделать инструкцию лучше:

1. ⚠️Структура документа (в Word) Вы сэкономите кучу времени, если сделаете структурированный документ (см. Рисунок 3) Часто приходится менять нумерацию пунктов, добавлять пункты перед и после, добавлять разделы. И нумерация автоматически проставляется, и навигация удобная.

- Возможно, это “спасибо, кэп”)

2. ⚠️Оглавление, которое работает Очень круто, когда можно сразу же на второй или третей странице найти пункт в оглавление, ткнуть в него мышкой, и документ нужную страницу откроет. Будет работать, если сделать пункт 1 (см. Рисунок 4)

- Конечно, есть еще ctrl+F)

3. ⚠️Иллюстрации Собственно то, что меня зацепило в инструкции Rock Shox. Картинки. Цветные, понятные, в нормальном качестве, где видно что делать/как должно быть/куда жать.

🔪Жёсткое правило: Пункт - Иллюстрация

Даже если в пункте 1.1 есть картинка, на которую надо сослаться в пункте 5.4, стоит сделать отдельную картинку для пункта 5.4, чтобы пользователь не листал.

- Если надо что-то выделить или указать направление, например, сделайте это фигурами в Word: прямоугольники, линии, стрелочки. (см. Рисунок 5) Велик соблазн нарисовать на скриншоте от руки - так быстрее, но выглядит убого)

- Лень - ваш главный враг, но надо хорошо поработать сейчас, чтобы потом не возиться с пояснениями лично)

- Особенно дико ломает переделывать нумерацию рисунков, когда вы переделали пункты. Это меня страшно бесит, еще и нумерация и ссылки могут полететь - не инструкция, а черт знает что получится. Поэтому:

🔪 Номер рисунка = номер пункта

🍻А какие у вас правила при составлении инструкций? Чем бы вы дополнили эти пункты?