Как написать внутреннюю документацию, которая работает

Как написать внутреннюю документацию, которая работает

Создание внутренней документации — не самая любимая работа, но как бы вы ни боялись документировать все подряд, без этого практически невозможно функционировать как бизнес. А набросать на бумаге несколько небрежных конспектов или скомкано изложить умозрительные идеи — это уже не то.  Помните: создавая документацию, вы не обращаетесь к людям, обладающим институциональными знаниями. Вы обращаетесь либо к людям, которые сидят вне вашей команды и не знакомы с жаргоном вашего отдела, либо к новичкам, которые еще не отличают CRM от CMS.  Я видел свою долю плохой документации и создал много (я надеюсь!) хорошей документации. Здесь я поделюсь своими советами по созданию документации, которая выдерживает испытание временем и которой люди действительно пользуются.

ЭЛЕКТРОНИКА

ЭЛЬДАРАДО

0.00

ЭЛЕКТРОНИКА

ДНС

799.00

ЭЛЕКТРОНИКА

ЮЛМАРТ

0.00

АПТЕКИ

36.6

0.00

ТРАНСПОРТНЫЕ КОМПАНИИ

БАЗА ТРАНСПОРТНЫХ КОМПАНИЙ

0.00699.00

ДОСКИ ОБЬЯВЛЕНИЙ

ЦИАН

0.00

Не увязайте в деталях

Если ваши внутренние документы настолько запутанны, что вы мучительно подробно описываете каждый отдельный процесс и концепцию в рамках этого процесса, вам и вашим читателям придется несладко. (Если только это не чемпионка по скорочтению Энн Джонс, которая может читать 4200 слов в минуту. В таком случае, можно мне получить вступление?) Вы также будете испытывать трудности, когда что-то неизбежно изменится, и вам нужно будет обновить документы в соответствии с этим.  Скажем, например, ваша команда переводит весь поток вебинаров на новый маркетинговый инструмент, чтобы лучше отслеживать участников и заполнение форм в одном месте. Представьте себе, что вам придется просмотреть 120 страниц документации, чтобы найти и искоренить любое упоминание о том, как вы раньше управляли вебинарами. Для всеобъемлющих процессов лучше сократить текст до удобоваримого формата, с достаточным количеством деталей, чтобы он был понятен, но не настолько глубоким, чтобы любое крошечное изменение в процессе делало весь процесс неактуальным.  Например, в компании Zapier я помогаю вести ежемесячный информационный бюллетень о продукте, и мне помогает простое изложение каждого этапа этого процесса.

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

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

Сохраняйте простоту процессов

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

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

Замените жаргон простым языком

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

Будь то учебные материалы, руководства для сотрудников или стандартные операционные процедуры, изложение всего в нескучной форме поможет новым членам команды быстрее войти в курс дела. Например, член команды начального уровня, только что пришедший в отдел маркетинга, не обязательно будет знать, что означает MAU или что означает «анализ критических KPI с точки зрения показателя отказов». Когнитивный психолог и лингвист Стивен Пинкер называет это явление «проклятием знания». Он придумал этот термин для описания того, что происходит, когда эксперты переоценивают уровень знаний неспециалистов. Мы склонны предполагать, что знаем слишком много, не предоставляем достаточного контекста и не даем определения аббревиатурам или жаргонам, которые считаем само собой разумеющимися.  Итак: предположите, что читатель легко поймет рассматриваемое понятие, но потратьте время на то, чтобы объяснить ему его так, как будто он никогда о нем не слышал. Например, глоссарий, который мы используем в Zapier.

Новички быстрее соединят точки и начнут оказывать реальное влияние на бизнес.

Включите более широкий контекст о каждой команде

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

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

База всех продавцов товаров на OZON. 10 000+ строк, контакты и ФИО директоров!*
This is default text for notification bar