← все записи

Что нужно, чтобы с документацией всё было ок


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

Ладно, шутка. Ответ на главный вопрос документации, знаний и всего такого — нет, не 42, ответ — “владелец”. Спасибо за внимание. Теперь вы знаете, как сделать хорошо.

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

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

При этом помимо технического писателя отвечать за доки может кто угодно — проджект, QA, тимлид. И они отвечают. Есть такие великие люди, которые понимают важность документации и сохранения знаний. Но давайте будем честны, для большинства это всё-таки задача второго или третьего приоритета.

Если рассуждать глобально, что поможет вашей компании на этом непростом пути сохранения знаний? И ответ многослойный, как селёдка под шубой:

  • культура,
  • процессы,
  • поощрение,
  • придумай тут что-то ещё, а то в селёдке больше слоёв

И вот как раз за этим вам нужен “владелец” знаний. Тот, кто будет поддерживать и строить вместе с руководителями компании её культуру. Кто будет настраивать процессы. Заниматься мотивацией и поддержкой сотрудников.

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

Тут потом что-то ещё допишу

Если у вас возникли вопросы или захотелось обсудить этот текст — пишите сюда.