Теоретический раздел документа

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

Содержание теоретического раздела

Основные темы теоретического раздела технического документа, как правило, таковы:

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

Предметная область

Точка зрения на предметную область

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

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

• объекты, которыми наполнена предметная область;
• процессы, которые в ней протекают с участием этих объектов.

Объекты предметной области

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

• Рассматриваемые объекты предметной области необходимо явно перечислить. Удобно это сделать, приведя определения терминов, которыми они обозначены в документе.
• Для многозначных терминов необходимо уточнить, в каком из возможных значений каждый из них фигурирует в документе.
• Значение термина в документе может быть несколько уже или несколько шире общепринятого, в этом случае его определение придется переформулировать.
• Разработчики технической документации или самого решения могут для простоты отождествить объект реального мира с его образом в информационной или математической модели. Тогда потребуется объяснить, что черной дырой они называют не сам космический объект во всем его ужасном великолепии, а набор параметров и уравнений, представляющих его в системе.

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

①	Контрагентом будем называть физическое или юридическое лицо, успешно прошедшее процедуру регистрации в системе.
②	Контрагента характеризуют следующие данные: ФИО или полное наименование; ИНН; адрес регистрации; банковские реквизиты; баланс взаиморасчетов контрагента с системой.
③	Каждый контрагент представлен в системе своей карточкой. Карточка контрагента хранится в базе данных системы. Она представляет собой запись, в которой собрана вся информация о контрагенте, доступная в системе.

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

• ① Указание на объект предметной области.
• ② Информационная модель объекта предметной области.
• ③ Представление объекта предметной области в системе.

Лексический инструментарий автора

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

• обобщающие термины;
• уточняющие термины;
• сопутствующая лексика.

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

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

Обломов остановился и прочитал написанное.

— Нескладно, — сказал он, — тут два раза сряду что, а там два раза который.

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

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

— И не отвяжешься от этого другого-то что! — сказал он с нетерпением. — Э! да черт с ним совсем, с письмом-то! Ломать голову из таких пустяков! Я отвык деловые письма писать. А вот уж третий час в исходе.

И. Гончаров, «Обломов».

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

Представим себе сервис электронного документооборота, о которой в технической документации сказано следующее.

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

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

Снабдим документ теоретическим разделом, включив в него следующие определения.

Основные понятия и определения

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

Участником электронного документооборота (или просто участником) будем называть лицо, имеющее учетную запись в системе.

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

• физическое лицо, прошедшее процедуру идентификации;
• юридическое лицо, загрузившее в систему квалифицированную электронную подпись руководителя.

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

Теперь перепишем исходное предложение, используя подготовленную терминологию.

Система позволяет полноправным участникам подписывать юридически значимые документы.

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

Источники

1. Острогорский М. Ю. Как мир устроен? Концепционный раздел руководства пользователя. — М.: «Философт», 2008. — Публикация в Интернете