Есть одна незаменимая спутница любого современного человека. Мы часто игнорируем ее, не замечаем и не признаем заслуг, пренебрегаем ей. Эта спутница - сопроводительная документация, в большинстве своих исполнений мы называем ее «инструкцией».
С любой инструкцией возникает вопрос: а насколько она должна быть обширной? Ну, вот скажем на школьной тетрадке бывает написана таблица умножения, а вот на учебнике по интегралам ее уже нет – подразумевается, что человек таблицу умножения уже знает. Наивно. Ну, так может нужно писать на инструкции какие базовые знания должен обладать человек, который эту инструкцию и будет читать? Определить уровень допуска к инструкции, а еще потом расписать, где этот уровень допуска получать. А ведь еще инструкции часто требуют задействовать абстрактное мышление. Оно правда не у всех развито, либо развито по-своему, что многие могли заметить на уроках черчения – всё-таки двухмерное с трёхмерным плохо сочетается без должной практики. Да я знаю, что есть люди, которые любят по-снобски «да что вы там не понимаете разницу между глубиной паза», но попробуйте преподать черчение детям и вы это обнаружите. Или ориентирование по карте человеку, который первый раз в жизни видит карту.
Всё это переливание из пустого в порожнее не просто так, дело в том, что я сталкивался по работе с проблемой «а обязана инструкция быть простой и понятной для низкопрофильного читателя, или же это обязанность читателя повышать свой профиль, чтобы суметь понять инструкцию?». И ответы на такой вопрос я слышал много и разных. Но есть одна интересна вещь, которая однажды дала свой ответ. Эта вещь называется война.
В основе эффективного обучения стоит процесс передачи информации от одного человека непосредственно другому. Желательно с практическими работами под наблюдением. Методы «тыка» и «самообучение по результату работы» иногда и приносят результат, но в процентном соотношении ничтожно мало людей такого добиваются. Проблема войны в том, что она слишком быстро съедает людей, которые что-то знали. А те, что узнали в процессе, не факт, что успеют донести информацию до окружающих.
В итоге мы получаем ситуацию, когда у нас ограниченное время на подготовку, кандидаты с низким уровнем профильной базы, а также отсутствие большого числа качественных инструкторов. Как решать такую задачу? Ответ был дан следующий – упрощаем документацию.
Один из интересных примеров служит документация на танковые узлы, в данном примере будет инструкция от танкового двигателя. Вообще, основой данного поста послужила подпись под видео просмотра инструкции от немецкого двигателя HM 500A, в подпись которому гласила «Охренеть! У немцев в 42 году даже пособие по ремонту получилось лучше, чем автомобили у русских в настоящее время!». Ну, так вот, точно такие же инструкции существовали у всей техники времен ВОВ – «Альбом конструкции» название таких схем. И делали их не только к отечественной технике, но и к технике ленд-лиза. Отсутствие САПРов решалось трудом художников, за который потом составителям инструкций также шли госнаграды. Пару примеров изображений я приведу в данном посте.
Но если честно, для меня больше впечатления создало отличие инструкции от советской солдатской палатки годов выпуска 41-го и 42-го года. Инструкция 42-го жирнее. Почему? В ней появилось большое описание как эту самую палатку устанавливать. И отдельно было описано как ее ставить зимой.
Простой пример того, что незнание убивает, а времени на снобское «надо было узнавать заранее» уже нет. Так и появлялась инструкция, которая была максимально понятной.
--------------------------------------------
Текст посвящаю своему опыту спора с "техническими писателями" на тему понятности документации. И аргументам по типу "может еще в стишках писать?". Будет надо - будете рисовать в виде комиксов, лишь люди поняли что где находится и как что делать.
Любите конечного пользователя вашего продукта и делайте вещи понятными для них. Добро вам вернется.е
Автор - Александр Прохоров