Close

Как создать идеальную внутреннюю документацию

Соберите все, что на уме у вашей команды, и сохраните в надежном месте

Просмотр тем
Рисунок: два человека редактируют страницу Confluence

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

А теперь представьте, что он решил уволиться.

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

Простите, если заставили вас нервничать! Но напряжение, которое вы ощутили, является отличной иллюстрацией того, насколько важна внутренняя документация.

Давайте подробно рассмотрим, что вам нужно знать для того, чтобы запустить и (или) оптимизировать этот процесс, не дожидаясь острой необходимости. Вы ведь знаете: готовить сани нужно летом…

Что такое внутренняя документация?

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

Она отличается от внешней документации, которую (как это ясно по названию) используют люди за пределами вашей организации, — например, от инструкций для покупателей.

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

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

Типы внутренней документации

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

Разумеется, это не единственный возможный вид внутренней документации. Другие распространенные типы перечислены ниже.

  • Документация команды. Информация, связанная с работой, которую выполняет команда. Это могут быть цели, планы проектов, график работы команды, отчеты о состоянии, протоколы собраний и т. д.
  • Справочная документация. Задокументированные процессы относятся к этой более широкой категории. Справочная документация помогает сотрудникам получить знания по важным темам, процессам и корпоративным политикам (к примеру, как подать заявление на отгул).
  • Проектная документация. Документация такого типа относится к конкретному проекту. Она может включать в себя предложения, требования к продукту, рекомендации по дизайну, наброски, дорожные карты и прочее.

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

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

Для чего нужна документация

Слишком многие компании недооценивают роль внутренней документации (пока нормальное течение процессов не нарушит какой-нибудь кризис, оставив их у разбитого корыта). Согласно исследованию BPTrends, лишь 4 % компаний всегда документируют внутренние процессы. Еще 50 % признают, что занимаются этим вопросом от случая к случаю.

А теперь пара реплик с импровизированной трибуны: не будьте частью такой статистики! Внутренняя документация действительно важна, и по многим причинам.

Выполняйте больше работы, не тратя время впустую

Допустим, вам требуется вместо коллеги выполнить рассылку клиентам информационного обзора за месяц. Быстро ли получится, если вы станете разбираться во всем самостоятельно? Или же будет гораздо быстрее, если перед вами окажется подробная инструкция со снимками экрана, поясняющими, как именно нужно извлечь и распространить информацию?

Второй вариант очевидно быстрее, да?

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

Поднимите адаптацию сотрудников на новый уровень

По данным компании Gallup, лишь 12 % сотрудников полностью согласны, что их организация успешно справляется с адаптацией новых кадров.

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

Стабильная практика создания внутренней документации формирует для новых участников команды ценный источник знаний, к которому они могут обращаться, спокойно осваивая все тонкости новой работы.

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

Запустите процесс обмена знаниями

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

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

Рекомендации по управлению документацией

Теперь у вас есть ответ на вопрос «почему» — давайте перейдем к «как».

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

Пишите просто и понятно

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

Снимок экрана: страница Confluence

Используйте примеры и графические материалы

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

Обеспечьте удобный доступ

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

Добавляйте нужные подробности

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

Стабильная практика создания внутренней документации формирует ценный источник знаний для новых участников команды.

Дайте дорогу тем, кто готов помочь

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

Используйте «живые» документы

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

Формирование процесса работы с внутренней документацией

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

1. Определите основные процессы

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

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

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

2. Создайте стандартный шаблон

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

  • Краткое описание, для чего существует данный процесс
  • Основные участники процесса
  • Что требуется для выполнения процесса (ПО, ресурсы и т. п.)

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

БОНУСНЫЙ СОВЕТ.

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

3. Определите, где хранить описания процессов

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

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

4. Выделите время для наведения порядка

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

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

Прочтите это руководство, чтобы подробно разобраться, как организовать процесс создания внутренней документации.

Чем может помочь ПО для создания внутренней документации

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

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

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

Избавьте команду от лишних проблем и забот

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

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

Вам также может понравиться

Шаблон статьи с инструкциями

Создайте пошаговое руководство для выполнения задания

Шаблоны Confluence

Создавайте в Confluence все необходимое, от требований к продукту до маркетинговых планов

продолжение темы
Process documentation