Что может быть общего между автором, населяющим кошмары клоунами-убийцами, ожившими автомобилями, и техническим писателем, чья главная задача — методично и ясно объяснить, как настроить роутер или использовать новый программный продукт? На первый взгляд — ничего. Но если заглянуть в саму суть писательского ремесла, можно обнаружить, что Стивен Кинг и хороший технический писатель следуют удивительно похожим принципам.
Пособие Кинга "Как писать книги" — это не только мемуары, но и блестящее руководство по созданию текстов. Давайте разберем его подход как своего рода "пользовательскую документацию" и посмотрим, как его приемы можно применить в работе над инструкциями и руководствами.
Глава I. "Что, если?" против "Как мне?"
Подход Стивена Кинга
В основе почти каждого романа Кинга лежит простая ситуация-допущение:
"Что, если школьница-изгой обнаружит у себя способности телекинеза?"
"Что, если писатель попадет в плен к своей самой преданной поклоннице?"
Кинг берет одну понятную, но нестандартную ситуацию и раскручивает ее, позволяя событиям развиваться максимально логично в заданных условиях.
Применение для технического писателя
Технический писатель работает с похожим, но более прагматичным вопросом: "Как мне?".
"Как мне сбросить пароль?"
"Как мне создать отчет?"
"Как мне подключить новое устройство?"
Вся документация, по сути, является развернутым ответом на эти вопросы.
Вывод
Не пытайтесь объяснить всё и сразу. Сконцентрируйтесь на одной конкретной проблеме или задаче пользователя (use case). Ваша документация — это решение конкретных задач "Что, если у пользователя возникнет такая проблема?". Каждый раздел, каждая инструкция должны начинаться с четко определенной цели пользователя.
Глава II. Персонаж определяет сюжет: знайте своего пользователя
Подход Стивена Кинга
Кинг неоднократно говорил, что сюжет для него вторичен. Он создает живых, понятных персонажей, помещает их в свою исходную ситуацию ("Что, если?") и смотрит, как они будут действовать. Поведение персонажей, их решения и ошибки двигают историю вперед.
Применение для технического писателя
Персонаж технического писателя — это его пользователь. Кто он? Новичок, который впервые видит этот интерфейс? Опытный администратор, которому нужны только технические спецификации? Разработчик, ищущий описание API?
Вывод
Прежде чем писать, создайте "портрет пользователя" (user persona). Понимание его технических навыков, целей и возможных "болей" определяет всё: язык документа, глубину объяснений, структуру и примеры. Документация для новичка, наполненная профессиональным жаргоном, так же бесполезна, как инструкция для эксперта, разжевывающая, как нажать на кнопку "Далее".
Глава III. Простота языка и "Ящик с инструментами"
Подход Стивена Кинга
Кинг — ярый противник вычурного языка, сложных конструкций и лишних слов. Его знаменитый совет — "дорога в ад вымощена наречиями". В своей книге он описывает писательский "ящик с инструментами", где на верхнем уровне лежат самые важные и простые вещи: богатый, но не показной словарный запас и основы грамматики. Сложные приемы — лишь на нижних полках, для редких случаев.
Применение для технического писателя
Это золотое правило для создания пользовательской документации. Ясность и однозначность — абсолютный приоритет.
Вывод
Используйте активный залог: "Нажмите кнопку Сохранить" вместо "Кнопка Сохранить должна быть нажата".
Будьте последовательны: используйте один и тот же термин для обозначения одного и того же элемента интерфейса на протяжении всей документации.
Избегайте жаргона, если без него не обойтись, объясните термин при первом упоминании, создайте глоссарий.
Пишите короткими предложениями. Каждое предложение должно нести одну мысль.
Ваш "ящик с инструментами" — это ваше руководство по стилю, глоссарий и утвержденные шаблоны.
Глава IV. Два черновика: пишем для себя, редактируем для других
Подход Стивена Кинга
Кинг придерживается строгого правила двух версий.
Первый черновик: пишет его быстро, "за закрытой дверью", не отвлекаясь на перфекционизм. Главная задача — выплеснуть историю на бумагу, рассказать ее самому себе.
Второй черновик: пишется "с открытой дверью". Кинг перечитывает написанное свежим взглядом, думая уже не о себе, а о читателе. На этом этапе он безжалостно сокращает текст (его формула: 2-й черновик = 1-й черновик — 10%), исправляет нестыковки и делает историю ясной и увлекательной для других.
Применение для технического писателя
Этот процесс идеально ложится на создание документации.
Вывод
Первый черновик: сосредоточьтесь на технической точности. Пройдите весь процесс сами, шаг за шагом, и задокументируйте его. Не беспокойтесь о красоте слога, просто убедитесь, что все шаги на месте и ведут к нужному результату.
Второй черновик (редактура): теперь посмотрите на текст глазами пользователя.
Понятно ли изложение?
Нет ли двусмысленных фраз?
Все ли шаги логичны?
Где можно сократить текст без потери смысла?
Именно на этом этапе добавляются скриншоты, предупреждения (Warnings) и примечания (Notes), чтобы помочь читателю.
Глава V. Идеальный читатель: фокус на одном человеке
Подход Стивена Кинга
Кинг признается, что пишет для "идеального читателя" — одного конкретного человека (чаще всего для своей жены, Табиты Кинг). Это помогает ему поддерживать единый тон повествования и не распыляться, пытаясь угодить всем сразу.
Применение для технического писателя
Это прямое воплощение концепции "портрета пользователя". Когда вы пишете, держите в уме одного конкретного человека — например, "Анну, 35-летнего менеджера проекта, которая не очень сильна в технике, но ей нужно быстро настроить отчеты". Этот мысленный образ не позволит вам скатиться в излишнюю техническую сложность или, наоборот, в примитивизм.
Эпилог
Стивен Кинг — мастер рассказывания историй, которые захватывают и не отпускают. Технический писатель — мастер объяснения, который проводит пользователя через сложный процесс, делая его простым и понятным. Их цели кажутся разными — напугать или помочь.
Но инструменты, которые они используют, во многом совпадают: фокус на аудитории, кристальная ясность языка, логичная структура и безжалостная редактура. Применяя принципы Короля ужасов, технический писатель может создавать документацию, которая будет не просто функциональной, а по-настоящему удобной, полезной и дружелюбной к пользователю. Ведь лучшая инструкция — та, что не вызывает страха и растерянности перед новой технологией.
Если бы Кинг писал пользовательскую документацию для какого-нибудь программного продукта, она, наверное, начиналась бы так: "Коммит за коммитом, как призраки в старом отеле, неупокоенный код приходил к новым разработчикам... пока не появился Dr.Explain и не привел в порядок этот цифровой кошмар!".
Самое время попробовать программу с готовыми шаблонами пользовательских документаций в деле!