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

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

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

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

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

Глава 8. Базовые приёмы работы с текстом

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

1. Лексические тонкости и основные ошибки в технических документах

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

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

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

• Нельзя путать дефис (как-то) и тире (осёл — это животное на четырёх ножках © Незнайка).

• Слово «Интернет» пишется с большой буквы и склоняется по падежам. Исключение составляют составные слова (интернет-кафе).

• В конце всех пунктов списка кроме последнего ставится знак «;» или ничего вообще.

• В конце последнего пункта списка всегда ставится точка.

• В документации просторечные обороты вида «кое-что» заменяются на вид «что-либо».

• В свою очередь «что-нибудь» превращается в «что-либо».

• Заранее определите, как будете выделять в тексте различные элементы, например: название клавиши, путь к файлу / имя файла. Обратите внимание, что стиль выделения должен быть сквозным по тексту, если выделения начнут путаться — это станет большим минусом.

• Имеет смысл вводить в текст блоки Внимание! — для акцента на важном моменте в описании и Примечание. — для сообщения дополнительных сведений или ссылки на них. Эти блоки визуально разнообразят текст и облегчают его восприятие.

• Блоков Внимание! не должно быть много.

• Если в тексте выделять какие-то важные моменты нужно достаточно часто, вместо вынесения их всех в блоки Внимание! Можно просто использовать полужирное начертание. Разумеется, в этом случае его нельзя будет использовать в этом документе для любых других типов выделения.

• Нумерация сносок всегда делается сквозной по документу.

• В документации не должны использоваться просторечные слова (надо, нельзя, не стоит и т. д.), только их литературные аналоги (можно, необходимо, требуется, нужно, недопустимо, возможно и т. д.).

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