Внутренняя документация, которую никто не читает. Как сделать, чтобы читали (на примере ONLYOFFICE Workspace)

Значимый прорыв формирует отрасль ИИ: akdengi 3 минуты назад Внутренняя документация, которую никто не читает. Как сделать, чтобы читали (на примере ONLYOFFICE Workspace) Простой 12 мин 13 Блог компании HOSTKEY Подготовка технической документации * Системное администрирование * IT-инфраструктура * Open source * Обзор Автор: Иван Богданов, Технический писатель Когда я пришел в компанию, главной моей задачей была документация. Точнее, та каша, в которую она к тому времени превратилась.

Часть статей писали люди, ушедшие за несколько лет до меня, и спросить, что там имелось в виду, было уже не у кого. Форматирование местами выглядело так, что глаз цеплялся за оформление вместо смысла, и читать это было физически тяжело. Хуже всего дело обстояло с систематизацией, статьи лежали как попало, и новичок успевал отчаяться, пока добирался до нужной.

Технические детали

С тех пор поменялось многое. Отдел писателей вырос, появились единые шаблоны статей, и они заметно упростили жизнь и авторам, и тем, кто потом вычитывает текст. За эти годы я хорошо понял, насколько документацию недооценивают.

Толковый регламент или гайд экономит чужое рабочее время, и чем крупнее компания, тем ощутимее набегает эта экономия с каждого внятного руководства. McKinsey Global Institute ещё в 2012 году оценивал, что офисный работник тратит на поиск внутренней информации и нужных коллег почти пятую часть рабочей недели, и с тех пор внутренних систем у компаний стало только больше. Отдельно стоит упомянуть онбординг, т.

когда новичку есть что почитать по процедурам в компании, он осваивается быстрее и нервничает меньше, ведь не приходится дёргать коллег вопросами по любому пустяку. Документация нужна не только для поиска решений. Она ещё и отвечает на вопрос, с кого спрашивать за ошибку.

Отраслевые последствия

Одно дело, когда инженер ошибся, потому что не знал, как правильно. Совсем другое, когда под рукой лежал подробный регламент, а человек всё равно сделал по-своему. Спрос в этих случаях разный.

Всё это работает, только пока документацию открывают. Открывают её, правда, далеко не всегда, и знакомый каждому дежурному сценарий объясняет почему. Идёт инцидент, сервис лежит, в рунбуке по восстановлению сервер называется так, как назывался восемь месяцев назад, и сорок минут уходит не на починку, а на выяснение, где инструкция врёт.

Можно, конечно, сказать, что просто сотрудники ленивы и безответственны, оттого не пишут и не читают, но чаще документацию забрасывают не от лени, а потому что она либо неудобна в использовании, либо низкого качества. Серверы в Европе, США и РоссииВыделенные и виртуальные серверы за рубли с быстрым развертыванием. Скидки и предустановленное ПО.

Событие, по словам экспертов, усилит конкуренцию в сфере ИИ.