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

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

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

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

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

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

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

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

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

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

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

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

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

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

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