Документация

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

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

Что делать...

Отказаться от видеоинструкций.
Попробовать интегрировать документацию с данными, ведь она тоже данные. Прямо описывать процессы некой базы данных в специальной таблице этой же базы данных. Тогда точно не потеряется.
Документация должна быть с быстрым поиском (отбором) по словам, как в любой современной информационной системе.
Обычно документация (инструкция) отвечает на вопросы со словом "Как", лучше если в ней также будут ответы на "Зачем" и "Почему".
В системе учета задач нужно записывать не только сроки, приоритеты, статус завершения и переписку участников (с руганью). Гораздо важнее подробное описание, как именно удалось задачу решить, опять же, чтобы в следующий раз легко это найти.

Что еще важно...

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

Как обычно, мало что в этом мире работает без нареканий, но ведь как-то живем и трудимся. Просто давайте стараться улучшать окружающую действительность, хотя бы по чуть-чуть. Ведь это не сложно...

←298 | заметка 299