Меню Закрыть

Чего не хватает в документации вашей компании? Контекст

Последнее изменение: 30.10.2023
Вы здесь:
Расчетное время чтения: 6 мин
Чего не хватает в документации вашей компании? Контекст

Документация компании имеет множество форм: «как делать», «что делать», «общие знания», «технологические документы» и т.д. Зачастую она имеет плохую репутацию — плоская, сухая и не более интересная, чем форма W2.

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

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

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

Если это не записано, то этого не существует

2020 год коренным образом изменил способ общения многих из нас. Речь идет не только о громкой речи через маску или замене рукопожатия на неловкий удар локтем. Она изменила способ общения на рабочем месте — похлопывания по плечу превратились в официальные встречи в Zoom, ежедневные совещания — в асинхронные обновления в Slack.

Чего не хватает в документации вашей компании? Контекст

Чтобы понять, как лучше ориентироваться в этой новой реальности, мы побеседовали с Винаем Хирематом, техническим директором и соучредителем компании Loom, специализирующейся на обмене видеосообщениями на рабочем месте, которая с самого начала создала культуру документирования в компании, ориентированной на удаленную работу. Третий сотрудник Loom был удаленным. Кроме того, Loom используют миллионы удаленных сотрудников по всему миру, что подчеркивает необходимость создания системы документации.

Представьте, что вам предстоит запуск крупного проекта. Если все идеи, зависимости, этапы процесса или вещи, которые необходимо сделать, живут в голове сотрудника — что произойдет, если он уйдет? Ваша интеллектуальная собственность будет потеряна.

Это не только ИС. Документация может:

  • Создание асинхронной связи — если ваша команда распределена, собрать всех на совещание практически невозможно. Асинхронная связь позволяет командам, находящимся в любом месте, вносить свой вклад и делает процесс принятия решений более эффективным.
  • Стандартизация процессов и сбор информации — на макроуровне вы хотите, чтобы команды следовали установленному процессу. На микроуровне это может означать написание постановки задачи, изучение зависимостей или консультации с другими членами команды. Документация описывает, как сделать то или иное действие и все детали, необходимые для его осуществления.
  • Помощь в развитии команды — документация обеспечивает долговременную память команды на важную информацию или процессы. Когда в компанию приходит новый сотрудник, вся эта информация сразу же становится доступной, и он может внести свой вклад в работу с первого дня.
  • Принуждение к более четкому мышлению — Винай утверждает, что именно в процессе написания текста происходит «сцепление резины с дорогой» ваших идей. Он заставляет четко формулировать концепции и причины их важности, а также зарождает новые взгляды на вещи.
  • Установление прозрачности в масштабах всей компании — большинство компаний говорят об этом, но запись того, что вы сделали и почему вы это сделали, помогает вам жить в соответствии с этим.

Документация Loom постоянно развивается, но она и близко не стоит с документацией таких компаний, как Gitlab, у которой справочник объемом 4 млн. слов занимает более 10 000 страниц.

Излагая свою философию документирования, Gitlab говорит: «По мере роста команды потребность в документации возрастает параллельно с ценой ее отсутствия. Другими словами, реализация стратегии документирования становится все более сложной и в то же время более важной по мере становления и развития компании».

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

Документация «как» и «почему»

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

На разных уровнях документа необходимо повторять «почему», — говорит Винай. Контекст отвечает на важный вопрос «зачем мы вообще это делаем?». Подобно тому, как Loom добивается того, чтобы в документах везде присутствовало «почему», Etsy использует эту схему для разграничения типов документации, которую создает ее техническая команда.

Чего не хватает в документации вашей компании? Контекст

«Почему документация» — это принудительная функция. Она требует от автора взглянуть на ситуацию и объяснить ход своих мыслей, как на широком, так и на детальном уровне. Почему проект важен? Почему мы делаем его сейчас? Почему мы делаем это именно так? Но «как» и «почему» должны жить рядом — они не должны существовать как отдельные документы.

Мы слышали от операционных команд, что, когда они объясняют, как выполнить новый процесс, а также почему они это делают, команда быстрее принимает его. Сотрудники получают ясность с высоты 10 000 футов. Они видят всю суть своей работы. Для крупного проекта это может быть сквозная линия к миссии компании, показывающая, почему этот проект важен и значим. Если речь идет о небольших изменениях в процессе, то «почему» может показать эффективность или экономию времени.

Кроме того, наличие в документации информации о причинах уменьшает количество тех разговоров, которые напоминают гонку NASCAR, полную одних левых поворотов.

Поэтому спросите себя — если документация важна для вашей команды, есть ли у вас информация о том, как и почему? Это дает команде необходимый контекст для того, чтобы проникнуться вашей миссией, работой и друг другом.

Три способа сделать контекст частью документации вашей команды

Если у вас уже есть надежная документация — или даже если вы только начинаете ее создавать, — включение контекста во все, что вы делаете, очень важно. Это поможет вам быстрее принимать решения, определять приоритеты и обеспечивать прозрачность.

1. Установить требования к контексту верхнего уровня, но оставить возможность для интерпретации

Именно руководители компаний должны заложить семена «почему» в документацию и установить определенные правила для ее включения. Если это приживется, есть надежда, что это будет развиваться повсеместно.

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

Чего не хватает в документации вашей компании? Контекст

И разные команды будут использовать этот инструмент по-разному. Loom имеет общекорпоративные шаблоны, но позволяет командам настраивать способы включения контекста в документацию. Например, в шаблонах Loom «запрос на комментарий» (RFC) запрашивается обратная связь с командой. Эти RFC содержат контекстные разделы, так же как и хартии продуктов, используемые для запуска крупных инициатив. Они есть и в итоговых отчетах. Шаблоны можно копировать одним щелчком мыши и изменять в соответствии с конкретными требованиями.

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

2. Использовать инструмент, способствующий более тесному общению

Контекст — это… сложно. Иногда один лишь текст не позволяет донести суть.

Loom использует Ноушен для создания документации компании, поскольку он позволяет централизовать информацию в разных командах. Но при этом она достаточно настраиваема, чтобы отдельные сотрудники или конкретные команды могли структурировать контекст таким образом, чтобы он соответствовал их предпочтениям или потребностям их работы.

«Если вы хотите научиться лучше общаться с командой и рассказывать о чем-то в своем собственном стиле, Ноушен отлично подходит для этого», — говорит Винай. «Здесь интереснее создавать свою идею и приятнее видеть результат».

Мы создали в Ноушен определенные функции, которые заставляют задуматься:

  • Комментарии и обсуждения способствуют асинхронной работе — асинхронное общение является суперспособностью в распределенном мире, который чрезмерно зависит от приложений реального времени, где сообщения пропускаются, а контекст теряется. На страницах Ноушен комментарии и обсуждения централизуют эту коммуникацию, чтобы ничего не упустить и услышать мнение каждого.
Tagging teammates is especially helpful for remote teams and asynchronous feedback.
Пометка партнеров по команде особенно полезна для удаленных команд и асинхронной обратной связи.
  • Поместите практически все, что угодно, прямо на свои страницы — Винай часто вставляет видеоролики Loom прямо на страницы Ноушен, чтобы объяснить их контекст. Будь то лумы, изображения, причудливые диаграммы или доски Miro, они могут помочь наглядно рассказать историю «почему».
Видеоролики, посвященные ткацкому станку, вставляются на страницы сайта Ноушен для наглядного пояснения выполняемой работы.
  • Соедините контекст с работой, на которую он влияет — контекст становится еще более эффективным, если он расположен рядом с работой, с которой он связан. Страницы понятий объединяют рабочие потоки и информацию. Если вы внедряете новый процесс, вы можете включить доску Kanban прямо под вашими «почему», чтобы оживить ваш контекст.
Используя связанную базу данных, вы можете показать версию заметок или документов на совещании в вики-системе вашей команды разработчиков.

Контекст настолько уникален, что зависит от конкретной ситуации. Ноушен предоставляет компаниям и командам внутри этих компаний необходимую гибкость, чтобы сделать его более эффективным. А если вам нужна помощь в настройке? У нас есть сертифицированные консультанты по Ноушен по всему миру.

3. Воспринимайте каждый создаваемый вами документ как упражнение по убеждению людей в чем-то.

«Невозможно быть старшим инженером в Loom, если ты не можешь убедить людей посвятить кучу своего времени и энергии чему-то, потому что это имеет смысл», — говорит Винай.

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

Чего не хватает в документации вашей компании? Контекст

В верхней части всех документов пишите «почему это критически важно». Затем повторите его важность и в конце документа. Это может зависеть от типа документа, который вы пишете.

Например, у Loom есть хартии продуктов, которые представляют собой длинные документы, описывающие проект и его реализацию. В них постоянно повторяется «почему» — в верхней части объясняется, зачем они создают эту вещь, в середине обсуждается процесс, а в нижней части — еще раз, чтобы донести суть.

Независимо от того, какую документацию вы создаете, она должна начинаться с вопросов «что» и «почему», прежде чем переходить к «как». Эта рамка обеспечивает необходимый читателю контекст.

Чтобы убедиться в том, что вы действительно пишете убедительно, подумайте над тем, чтобы ответить на следующие вопросы где-то в приведенном вами контексте:

  • Каковы мотивы людей в команде? Как можно связать работу, которую необходимо выполнить, с тем, что их вдохновляет?
  • Какие иголки в масштабах компании будет двигать эта работа? Какую известность это даст команде среди влиятельных людей внутри компании? Что покажет им успех?
  • Какие навыки или компетенции команда должна приобрести в ходе реализации данного проекта?

Если вы попали в эти точки, вы не только привели убедительные аргументы, но и вдохновили команду на лучшую работу.

Контекст показывает, чему научилась ваша компания по мере своего развития

Рассматривайте документацию своей компании как дерево — она будет расти вместе с вашей командой. Контекст в этой документации показывает эволюцию вашего мыслительного процесса, как если бы вы разрезали дерево, чтобы увидеть его кольца.

Винай говорит, что «почему» полезно как для создателей документов, так и для читателей. Создатели укрепляют свои мысли. Читатели видят, почему то или иное направление было приоритетным, что компания считала важным тогда и как это мнение изменилось.

Именно такая перспектива помогает опираться на прошлое и наметить путь вперед.

Была ли эта статья полезной?
Нет 0
Просмотров: 40

Читать далее

Предыдущий: Компания Ноушен приобретает Cron, календарь нового поколения
Следующий: Все, что вам нужно знать о рабочих процессах проектов для вашего стартапа