Мы приступаем к третьей, заключительной, и едва ли не самой трудной стадии работы над текстом - его словесным воплощением. Эта стадия предполагает многообразие общих и частных решений, связанных с подбором слов и выражений, составлением конкретных фраз и абзацев. Обычно говорят о стилистике текста или стилистической культуре его автора; вот и мы назвали эту главу: "Проблемы стиля технической документации". Действительно, стиль, стилистическая культура играют едва ли не ключевую роль в создании высококачественных технических текстов. Мы сформулируем основные преимущества хорошего стиля. В отличие от плохого, он:

• Облегчает восприятие документации пользователем.
• Повышает авторитет документации в глазах пользователя.
• Позволяет автору быть более гибким и тактичным в "общении" с пользователем.
• Дисциплинирует мышление разработчика документации.

По каждому из этих пунктов необходимы комментарии.

1. Грамотная речь всегда понятнее, чем безграмотная. За стилистической культурой стоят века отработки оптимальных способов передачи информации с помощью слов и как минимум десятилетия формирования стиля технических текстов. Кроме того, Ваш адресат - пользователь - перед тем, как взяться за написанную Вами документацию, наверняка читал другие книги и имеет некоторые представления о том, каким бывает стиль того или иного текста. Если Ваш текст обманывает ожидания, это затрудняет его восприятие.
2. Грамотная речь вызывает уважение к ее носителю. И не стоит успокаивать себя тем, что пользователь будто бы не станет предъявлять к документации высоких стилистических требований. Во-первых, если на первую сотню пользователей найдется один придира, который не поленится послать Вашему заказчику ехидный email с подробным перечнем Ваших огрехов, мы Вам не завидуем. А во-вторых, страшен не этот придира, а сотни "невзыскательных" пользователей, которые подсознательно почувствуют, что с ними разговаривает не компетентный и грамотный специалист, а так, случайный человек.
3. Владея стилем, Вы в меньшей степени рискуете сказать оскорбить или задеть пользователя, а также вызвать у него неуместный смех. Стилистически грамотный автор более эффективно отслеживает подобные сомнительные пассажи и заменяет их другими, более подходящими.
4. Стилистически безграмотный текст чаще всего бывает, вдобавок ко всему, двусмыслен, противоречив и неполон. Ведь в подавляющем большинстве случаев стилистическая неряшливость сопутствует неряшливости в формулировках, определениях, описаниях процедур и функций и пр. Очень часто плохой стиль свидетельствует о недостаточной продуманности излагаемых мыслей.

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

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

Стилистика документации складывается из двух составных частей:

• Практической стилистики русского языка.
• Стилистических особенностей технической документации.

Практическая стилистика русского языка - обширная дисциплина, входящая, наряду с правилами орфографии и пунктуации, в единый комплекс общенациональной культуры речи. Она накладывает определенные ограничения на употребление тех или иных слов, их сочетаемость друг с другом, правильное употребление падежных форм, построение предложений и т. д. Мы не ставим своей задачей описать весь круг этих правил; существуют превосходные учебники по стилистике, среди которых следует в первую очередь назвать пособие покойного Д. Э. Розенталя (см. Примечание 1). Заметим при этом, что:

• Орфографические, пунктуационные и стилистические правила русского языка автоматически включаются в корпоративный стандарт фирмы "Философт".

Стилистические особенности технической документации определяются прикладными задачами последней. Мы уже говорили, что сама документация представляет собой попытку достижения определенных целей средствами языка. Если Вы научитесь видеть в языке обширный ресурс таких средств и пользоваться им в соответствии с поставленными целями, многие стилистические требования покажутся Вам естественными и логичными. Вот почему наше изложение строится на трех вопросах:

• Что описывается в документации?
• Какие средства существуют для этого в языке?
• Каким образом они применяются?

---

Примечания

1. Д. Э. Розенталь.