Александр Михайлов - Профессия Технический писатель, или Рыцари клавиатуры

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

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

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

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

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

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

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

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

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

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

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

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

Если продукт предназначен для крупных фирм — в материалах для руководства надо говорить мало и строго по сути, так как читать стену текста они не будут, в основном указывая выгоды и преимущества использования(какие выгоды оно принесёт) вашего продукта.Если вы ориентируетесь на небольшие компании — лучше красочно описать преимущества самого продукта(насколько он хорош и универсален с технической точки зрения).

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

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

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

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

Исходя из полученного ранее материала, вы, готовясь к написанию технического документа, уже смогли ответить на основные вопросы: на каком носителей он будет поставляться пользователям, к какой глобальной категории относится его ЦА (внешние, внутренние, широкий круг и т. д.) и, собственно, кто именно является его основной аудиторией. Теперь же вам нужно разработать то, на чём будет базироваться ваш документ — его структуру.

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

Вся руководящая документация (пользователя, администратора и т. д.), все инструкции и документы, описывающие то или иное устройство или программу, по сути своей имеют общую структуру. Её материальным и видимым воплощением является оглавление документа. И именно с него вам и потребуется начать свою работу. Стоит отметить, что браться за написание руководства к программе можно лишь тогда, когда вы уже изучили её вдоль и поперёк. При попытке описать продукт параллельно с его изучением (по принципу: «что вижу — то пою»), вы с очень высокой (примерно 146%) вероятностью сядете в лужу или, в лучшем случае, сделаете всю работу два раза подряд, поскольку вам придется постоянно возвращаться по тексту назад, чтобы исправить всплывшие в ходе дальнейшего изучения программы нюансы или неточности.