Table of contentsPreviousNext


4.3

Синтаксис документации и его возможности

4.3.1

Общие замечания

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

Мы не будем останавливаться на том, какие связи устанавливаются между словами в русском языке и как эти связи реализуются. Наиболее типичные ошибки будут рассмотрены нами в Главе 5. Мы сосредоточимся на следующих вопросах, которые нуждаются в особом обсуждении:

4.3.2

Формализация изложения, ее возможности и аспекты

4.3.2.1

Значение формализации изложения

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

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

Формализация изложения является важнейшим средством, которое позволяет:

Формализация изложения позволяет пользователю быстро и по большей части бессознательно рассортировать информацию, с первого взгляда опознать знакомые или типичные действия, процедуры, проблемы и т. д. Напротив, отсутствие должной формализации изложения заставляет его каждый раз вникать в ситуацию как в совершенно новую, не имеющую аналогов. Вот почему формализация упрощает работу с документацией.

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

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

4.3.2.2

Унификация языка

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

Одинаковые объекты в документации называются одинаково; одинаковые отношения между объектами описываются одинаковыми конструкциями. Разные объекты и отношения должны называться (описываться) по-разному.

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

Напоминаем, что стандартная терминология представлена в Словаре стандартных компьютерных терминов* и является корпоративным стандартом фирмы "Философт".

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

Однако у всякого термина существует своя околотерминологическая среда. Мы имеем в виду следующее. У каждого слова есть своя способность сочетаться с другими словами. Например, известно, что можно сказать "играть роль" и "исполнять роль"; нельзя, однако, сказать "воплощать роль". Зато можно сказать "воплощать на сцене образ". Существуют специальные словари сочетаемости слов.

Под околотерминологической средой мы понимаем те слова, которые, вообще говоря, не являются терминами в узком смысле слова, но "обслуживают" слово-термин.

Ср. также рассуждение о выражениях типа "менять параметры", "изменять параметры", "установить новые значения параметров" и др. в п. 4.2.2.2.

Околотерминологическая среда также должна быть унифицирована. Для стандартной терминологии она представлена в Словаре стандартных компьютерных терминов*. Для остальных Вы должны продумать и создать ее самостоятельно в процессе формирования терминологии Вашей документации.

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

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

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

Говоря об унификации языка, необходимо помнить, что терминология в процессе работы зачастую сильно меняется - "плывет". Поэтому имеет смысл время от времени совершать проход по всему тексту, выравнивая терминологию и околотерминологическую среду.

4.3.2.3

Стандартные и специфические клише

Если мы вернемся к "резерфордовской" модели (см. п. 4.3.2.2), мы вспомним, что материя не только делится на молекулы; в ней имеются и более высокие уровни организации. Так и в нашем случае: формализация технического текста не исчерпывается унификацией языка. Существует целый ряд процедур, фрагментов интерфейса и т. д., которые встречаются при работе со многими программными продуктами. Это не удивительно, поскольку каждый программист как правило использует типовые решения. И это тем менее удивительно, что значительная часть программных продуктов сегодня оптимизируются для работы под Windows 95/98. Совершенно нет необходимости столкнувшись, например, со стандартной процедурой буксировки объекта с помощью мыши, каждый раз описывать ее заново. Рекомендуется пользоваться разработанным для подобных ситуаций клише.

Мы располагаем такими клише для описания работы с проводником, диалоговым окном и т. д.

Ряд клише является частью корпоративного стандарта фирмы "Философт" и включен в "Перечень стандартных клише"*.

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

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

4.3.3

Порядок слов

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

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

Каким образом порядок слов может служить для передачи информации? Эта функция выполняется двояко:

Инверсией в расположении членов предложения считается отклонение от так называемого прямого порядка слов. Прямой порядок может быть разным для разных типов и структур предложений. Мы не имеем здесь возможности рассматривать их все и продемонстрируем, что имеется в виду, на примере простого повествовательного предложения с довольно типичной структурой:

"В случае обнаружения вирусов пострадавший пользователь немедленно сообщает это администратору".

Необходимо сюда добавить еще два или три правила относительно определений:

Остальные члены предложения располагаются более свободно, хотя и с известными ограничениями:

Инверсия порядка слов порождает довольно резкую эмфазу - смысловое ударение на каком-то из членов предложения. Это ударение при инвертированном порядке слов падает обычно на конец фразы. Пусть, например, фраза выстроена так:

"Это немедленно сообщает администратору в случае обнаружения вирусов пострадавший пользователь."

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

"В случае обнаружения вирусов именно пострадавший пользователь немедленно сообщает это администратору".

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

Есть основания ограничивать использование инверсии в технических текстах, а для выражения эмфазы применять другие средства, например усилительные частицы: "именно", "же" и т. д.

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

Распределение информации по всей длине предложения связано с тем, что в современной лингвистике называется актуальным членением. Предполагается, что содержание предложения членится на тему и рему. Тема - это то, что известно заранее, задано всем предшествующим контекстом; рема - это то, что в предложении сообщается нового и актуального.

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

Такое распределение информации по длине предложения обусловлено следующими факторами:

Например, в приведенной выше фразе темой является условие: "В случае обнаружения вирусов", а ремой - описание действий пользователя. Читатель документации сначала опознает тему (у него, вероятно, уже возникал вопрос: что делать, если я найду в своем компьютере вирус?), а затем, на излете фразы разрешает свои раздумья новой информацией о том, что именно нужно сделать.

Расположение темы и ремы в таком порядке для простых предложений является признаком нейтрального, не окрашенного экспрессией стиля. Для сложных предложений такая последовательность сохраняется: условие, причина, цель выступает как тема, а следствие или средство к достижению цели оказывается ремой:

"Если пользователь обнаруживает вирусы, он немедленно сообщает это администратору."

"Чтобы сохранить файл, нажмите на кнопку или выберите в меню пункт "Сохранить"".

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

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

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

4.3.4

Ритмическая организация речи и ее значение

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

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

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

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

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

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

4.3.5

Неоптимальные конструкции и борьба с ними

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

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

Если в построении фразы трудно разобраться, эта фраза составлена неверно!

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

Умение писать сразу ясно и четко приходит не сразу. Представьте, что Вы написали фразу, а потом критически ее перечитали и ужаснулись. Необходимо владеть основными техниками упрощения и оптимизации синтаксиса. Мы перечисляем здесь несколько советов

Попробуйте расщепить слишком длинную и/или слишком запутанную конструкцию на два, а то и на три предложения.
Попробуйте четко сформулировать мысль, которую Вы пытаетесь выразить, разбить ее на тему и рему. Зачастую уже при этом она распадается на две или три мысли, каждую из которых имеет смысл сделать предметом отдельной фразы.
Постарайтесь хотя бы частично избавиться от причастных и деепричастных оборотов, а также родственных им придаточных со словом "который".
Если уж Вы употребляете причастные обороты или придаточные с "который", ни в коем случае не допускайте, чтобы между причастным оборотом / придаточным-определительным и определяемым словом вклинивались какие-то еще слова.
Постарайтесь мысленно или на бумаге вычертить схему связей между словами в написанной Вами фразе. Помните: особенно затрудняет чтение, когда необходимо ходить по кругу: возвращаться назад, потом снова двигаться вперед.
Проследите, чтобы связи между словами отражались точно и в соответствии с семантикой этих слов.
Избегайте всякого рода неоднозначных утверждений; особенно остерегайтесь в этом отношении местоимений, которые отсылают читателя к предыдущей фразе или ее части.
По возможности избегайте паразитных конструкций вроде "в ходе функционирования".
Старайтесь, если это возможно, избегать четырехкратных (и более) родительных падежей, повторного (в рамках одной фразы) употребления союзов, предлогов и пр.

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


Table of contentsPreviousNext

(c) 1999, PhiloSoft

Тел: +7 (495) 7878-179
E-mail: mail@philosoft.ru
Web: http://www.philosoft.ru