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

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

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

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

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

Один мудрец сказал: "Если от удара книги о голову раздается пустой звук - всегда ли виновата книга?"

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

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

Чтобы выстроить осознанное применение языковых средств как единую систему или методику, нам имеет смысл разбить процесс создания текста на несколько стадий. Классические риторы, вслед за Марком Фабием Квинтиллианом, разбивали работу над текстом на три основные части: изобретение (inventio), расположение (dispositio) и словесное исполнение (elocutio) (см. Примечание 1). Изобретение - это этап, на котором в общих чертах составляется замысел текста, общая логика изложения. Расположение - следующая стадия, на которой автор подробно прорабатывает план будущего текста и распределяет по нему, "располагает" материал. Наконец, словесное исполнение состоит в написании самого текста, подборе конкретных слов и выражений, отшлифовке стиля. Надо сказать, что эта трехчленная методика использовалась столетиями и вполне доказала свою продуктивность.

Нам представляется разумным положить трехчленную схему и в основание настоящего Руководства, по крайней мере его значительной части. Так, Глава 2 посвящена разработке общей логики изложения, а Глава 3 - рационального расположения информации в тексте. Заметим, что методические указания, которые содержатся в этих главах, в основном лингвистически универсальны, иными словами - применимы к текстам на любом языке. Напротив, в Главе 4 обсуждаются проблемы стиля технической документации, поэтому здесь много рекомендаций, имеющих отношение к русскому языку, специфическим для него возможностям и ограничениям.

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

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

Говорят, Л. Д. Ландау в ответ на замечание одного из слушателей: "Я не понял, как Вы получили этот вывод", - ответил: "Теоретическая физика вообще очень сложная наука".

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

Примечания

1. На самом деле они добавляли к этому еще две части: запоминание и произнесение; однако они актуальны лишь для устных ораторских выступлений.