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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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