Свежий номер №43 (420) / Милостивый государь, технический писатель Дата публикации: 12.11.2001 Владислав Головач, vladislav.golovach@usethics.ru Владимир Головач, golv@rarus.ru
Слово «писатель» звучит горделиво: креатив, алквиад. Однако прилагательное «технический» снимает всякие богемные ассоциации. Разница между писателем и техническим писателем такова же, как между государем и милостивым государем. Эти заметки выросли из врезки к статье одного из нас «Adobe FrameMaker. Солдат невидимого фронта», опубликованной в журнале «Курсив» (№6, 2000 год). В ней посильно анализируется качество труда технического писателя, работающего на русском языке в индустрии программирования. Зачем нужны технические тексты Что касается оперативных справок - с ними все ясно. Собственно говоря, одна из важнейших причин успеха Windows - прекрасно продуманная система их написания. Разработчикам стало проще писать оперативные справки, а пользователям - легче ими пользоваться. Эта система справок, существующая достаточно давно, практически не потеряла значения и сейчас, с появлением, например, HTML. Однако справочная система не может служить заменой печатного руководства (в дальнейшем - Руководства). Это связано прежде всего с иными принципами восприятия печатного текста и текста справки на экране:
С печатным руководством, казалось бы, тоже все ясно: это учебник и/или справочник по программе (тут изначально заложено противоречие коня и трепетной лани, но этого мы сейчас касаться не будем). Однако часто не принимается во внимание важная функция Руководства, которую уместно назвать рекламной. При беседе с потенциальным покупателем программного продукта и демонстрации достоинств последнего обязательно встает вопрос о Руководстве. Конечно же, это связано с подсознательным желанием клиента получить за свои деньги нечто материальное. Наличие Руководства не отменяет нужду в собственно рекламных (информационных) материалах, но хотелось бы подчеркнуть, что Руководство само по себе должно играть роль важного рекламного материала. Качество Руководства - важный намек на качество программы. На Западе полнота Руководства важна для предупреждения возможных юридических неприятностей: если клиент в результате некоторых действий понес потери, и эти неправильные действия в документации явно не запрещались, то это как минимум - основание для возврата денег, уплаченных за пакет. В нашей стране с укорененными традициями экономии на программном обеспечении (не его качестве и количестве, а на стоимости) печатное руководство важно для другого: отдельно издаются пиратские диски, отдельно - пиратские книги, но то и другое никогда не объединяют. Если продукт коробочный (то есть руководство спрятано внутри и до покупки не доступно), то рекламная роль руководства этим не умаляется. Таким образом, при обсуждении аспектов технического писательства было бы неправильно игнорировать проблемы, связанные с разработкой рекламных (информационных) материалов. Типичные особенности технических текстов Самая главная особенность технических текстов: они переиздаются вновь и вновь (раз в декаду, месяц или в квартал), и перед каждым новым изданием правятся (а иногда правка производится тайком). Второе: обычно объем этих текстов велик. В ходе правок объем неуклонно растет. Руководство практически никогда не пишется (не переписывается) одним человеком. Обычно в его написании принимают участие многие, но «швы» для читателя должны быть незаметны. Другими словами, Руководство должно выглядеть единообразно. Итак, мы подошли к третьей важнейшей особенности Руководства - единообразию. Эта особенность часто недооценивается. Принимая решение о покупке, потенциальный пользователь заглядывает в руководство, чтобы оценить - сможет ли он работать с программой. Такая оценка производится довольно поверхностно, но от ее результатов во многом зависит решение клиента: если выхваченные глазом кусочки материала производят впечатление понятного, то возникает ощущение, что удастся разобраться и с программой. Если же не удается с ходу разобраться в том, что написано, то сомнения по поводу приобретения программы усугубляются. Технический текст должен усыплять бдительность потенциального покупателя, создавая иллюзию, что работе с программой легко научиться. Важнейший шаг создания этой иллюзии - успокоительная узнаваемость и монотонность подачи материала. Таким образом, требования к техническому тексту подчинены задаче достижения единообразия. Нумеруется все - не только разделы, но и таблицы, рисунки, шаги процедур. Номер обязательно должен содержать видовую информацию (например, номер таблицы может быть таким: «Табл. 6-73», где «Табл.» - фиксированный текст, «6» - номер главы, а «73» - порядковый номер таблицы в главе). Эти номера должны расставляться автоматически (иначе в результате правок нумерация «поплывет»).
Нумерация нужна прежде всего для ссылок. Ссылки используются как в самом Руководстве, так и вовне: облегчают выписку рецептов службой технической поддержки (особенно по телефону). Когда все пронумеровано, у читателя возникает ощущение, что учтено также все. Полезное ощущение на этапе «предпродажной обработки клиента». Часто в нескольких разных местах Руководства требуется представлять один и тот же материал (например, определение, ограничение и т.п.). Буквальное повторение неудобно по следующим трем причинам:
Выход здесь есть: ссылки. Ссылки, разумеется должны быть прямыми, такими, чтобы на нужное место можно было выйти без помощи оглавления (любая ссылка должна сопровождаться номером соответствующей страницы). Ссылки несут еще одну важную функцию: тогда, когда Руководство будет поставляться в электронном виде (например, в формате pdf или html), по этим ссылкам можно будет ходить! То есть когда наступит время Х, Руководство сразу будет содержать гиперссылки. Важный аспект использования ссылок - указатель терминов. Указатель терминов - обязательный компонент любого англоязычного технического текста (от учебника до Руководства). Однако в кириллических текстах зачастую указателя либо нет совсем, либо он неполон. Если указателя терминов нет, то ценность Руководства сокращается пропорционально квадрату его объема. Руководство без указателя терминов - нонсенс. Иногда нужны также глоссарии, списки рисунков и пр. Все это, возможно, не очень нужно реально, но производит седуктивное действие на клиента. Известны три способа разбиения единого текста на несколько потоков: врезки, таблицы и боковики (как в этих заметках). Для Руководств особенно ценны таблицы. Это обусловлено следующими их свойствами:
Однако непременное условие применения таблиц - их единообразие. Жалкое впечатление производят таблицы, которые выглядят по-разному (если это не обусловлено необходимостью иной подачи материала). Великий и могучий Конечно, многие проблемы технического писателя упираются в русский язык. Технический текст должен быть написан безличным языком, не вызывающим никаких эмоций. Вероятно, безличности добиться так же трудно, как и выработать индивидуальный стиль.
Смело применяйте глаголы в повелительном наклонении - их пользователь любит. Вам следует использовать местоимения 2-го лица и действительный залог. Не вредно не употреблять двойные отрицания. Избегайте (следует избегать) страдательного залога - тяжкого наследия советской квазинауки. Избегайте также (просто-таки рекомендуется избежание) отглагольных существительных. Обширные абзацы и длинные перечисления (маркированные списки) утомляют читателя, ничего не давая ему взамен. Разумеется, терминология должна быть стандартной. К счастью, о русской компьютерной терминологии позаботился великий и могучий Микрософт 1. Это не ирония: в советское время разнобой в терминологии был ужасающим. Лингвисты (кажется, общим числом два), сотрудники Микрософта из Дублина сделали невозможное: разные пользователи компьютеров могут говорить на русском языке и даже в определенных пределах понимать друг друга! Конечно, отдельные термины, введенные Микрософтом, поначалу вызывали у снобов отторжение. Однако невозможно не согласиться (хорошо сказано!), что весь комплект терминов, впервые появившийся в русских Руководствах этой компании, принят народом (что удивительно, практически целиком и без корректив).
[i42022] 1 (обратно к тексту) - При транслитерации этого названия лучше не отклоняться от традиции русского языка, зафиксированной, в частности, в словарях. Мы же не говорим «майкроскоп» и «майкроцефал». 2 (обратно к тексту) - А применять сноски (подстраничные и подтабличные) обычно имеет смысл: сноска - самостоятельный текстовый поток. 3 (обратно к тексту) - В ноябре издательство «Питер» выпускает замечательную книгу - Adobe FrameMaker 6.0, Учебный курс. Подготовка кириллических публикаций. Еще бы этой книге не быть замечательной, если мы сами ее и писали, и разрабатывали шаблоны верстки.
|