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

1. Области, в которых присутствует работа с текстами

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

• IT-отрасль в целом — здесь нужна аналитика, документация и ещё много всего.

• Наука — мало провести большое исследование, надо ещё грамотно его описать и представить.

• Журналистика — хороший, схватывающий на лету технический писатель после нескольких лет практики сможет описать что угодно и стать первоклассным журналистом.

• Любая сфера, связанная с применением электронного оборудования, энергетикой, бизнес-планированием, аналитикой и экономикой.

2. Классификация носителей информации

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

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

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

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

У данного типа текстов есть преимущество в виде ряда возможностей:

• Использовать перекрёстные ссылки (перелинковку) внутри документа;

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

• использовать составленное из ссылок оглавление как навигатор по документу;

• добавлять картинки или схемы с увеличением «по щелчку», видеоролики, gif-файлы;

• делать слова-ссылки, не прописывая адреса в явном виде.

Тексты, предназначенные для чтения исключительно с экрана, как правило, относятся к одной из категорий:

1. Базы знаний на основе Wiki-технологии. Такая база знаний формируется в крупных компаниях, где часто появляются новые сотрудники и им нужно выдать большой объём информации, для чего wiki-страницы с их перелинковкой подходят идеально. Кроме того, некоторые разделы могут быть доступны пользователям, в них можно публиковать какие-нибудь полезные сведения, по тем или иным причинам не вошедшие в документацию. Например: антивирусный разработчик может выкладывать в wiki статьи, посвящённые описанию методов борьбы с различными вирусами при помощи как продукта самой компании, так и иных технологий, например, ручного поиска с применением сторонних утилит. Такой кладезь информации привлечёт на сайт и рядовых пользователей, у которых возникла проблема с персональным компьютером, и системных администраторов, которым требуется избавить от заразы целый парк рабочих станций. Наличие подобной базы знаний, свидетельствующей о лояльности компании не только к своим клиентам, но даже просто к гостям сайта, может стать важным аргументом в решении вопроса о переходе на антивирусную продукцию именно этой марки. Причём такое решение может быть принято как одним пользователем, так и целой фирмой через её системного администратора.

Рис. 2. База знаний на сайте http://wiki.7405405.ru

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

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

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

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

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

Рис. 3. Онлайн-документация на сайте Dr.ExpLain (www.drexplain.ru)

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

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

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

Ссылки на различные места в документе можно делать перелинковкой, но в виде «кликабельных» слов вида «См. Раздел 3».

Также нужно избегать вставки внешних ссылок, так как у пользователя, имеющего только распечатку, может не быть возможности открыть ссылку на ПК (например, компьютер не имеет доступа в Интернет). Вместо ссылок можно делать сноски, в которых и размещать весь важный материал. Если объём информации по ссылке слишком велик, то его можно либо целиком внести в основной текст документа, либо все же сделать ссылку, но уже в явном виде, не заменяя текст ссылки словом. Например: www.google.ru.

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

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

• подобрать оптимальные для восприятия размеры и оформление шрифтов, так как у читателя нет возможности изменить их масштаб и начертание;

• соблюдать поля таким образом, чтобы части текста и рисунков не вылезали за них;

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

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

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

3. Типы пользователей документации

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

Вообще, все читатели наших текстов условно делятся на три глобальные группы:

• сотрудник компании, в которой пишется документ;

• сторонние лица: пользователи, клиенты и т.д.;

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

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

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

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

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

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

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

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

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

Руководство согласно, надо писать программу.

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

Естественно, приведённая схема упрощена до невозможности, но суть задачи по распределение текстов внутри компании она передаёт верно.

К документам для внутреннего использования относятся:

• любые описания и комментарии к программному коду и базам данных;

• рабочие регламенты и бухгалтерские документы (например, штатное расписание);

• ролевая документация для различных сотрудников (не путать с ролевой документацией для клиентов);

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

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

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

Это как раз тот случай, когда немного здоровой паранойи не помешает — она убережёт вас от излишне полного (да-да, и такое бывает!) описания продукта.

К документам общего пользования относятся:

• руководства пользователя, администратора;

• ролевая документация для сотрудников компании-клиента (например, руководство оператора программы для внесения сведений о продукции на складе);

• обзоры и аналитика, рассчитанная на широкий круг лиц;

• пресс-релизы и вся PR-продукция компании.

Это наиболее распространённые тексты, с которыми приходится работать, на них приходится до 90% всех документов, выпускаемых компанией.

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

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

К данному типу относятся только комплекты конструкторской и программной документации в целом.

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

4. Основные группы пользователей документации

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Если речь об описании баз данных (далее: БД), то описываются все таблицы БД, их поля, строится карта взаимодействия (графическая схема БД). Другие данные для описания таблицы не требуются — специалисту по работе с ней упомянутых сведений будет более чем достаточно.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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