Всё для технического документирования
+7 (495) 001-40-42
Разработка технической документации
Курсы для технических писателей
Программное обеспечение

Пять вопросов, которые нужно задать себе при создании нового отдела документации (часть 1)

09.07.2014

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


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

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

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

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

Вот эти вопросы:

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

Что нужно сделать?

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

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

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

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

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

Когда это нужно сделать?

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

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

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

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

(продолжение следует)

Источник: Five questions to ask yourself while creating a new documentation department

Тэги: , ,

< Вернуться к списку публикаций

Облако тегов