Как стать автором
Обновить
563.47
ГК ЛАНИТ
Ведущая многопрофильная группа ИТ-компаний в РФ

О нашем умении писать по-русски IT-документацию

Уровень сложностиСредний
Время на прочтение21 мин
Количество просмотров6.4K

Все мы думаем, что хорошо говорим и пишем на своём родном русском языке. Не зря же в конце концов мы столько учились, да и в деловой переписке у нас всё вроде бы вполне неплохо. Но знаете ли вы о том, что даже для написания IT-документации есть свои правила? Поэтому сегодня в блоге ЛАНИТ на Хабре мы поделимся знаниями о русском «документном» языке. 

Как вам видится вот такой текст, который извлечён из руководства пользователя программы, подготовленной для одного из банков нашей страны: «Подсистема поддержки операций с драгоценными металлами предназначена для оформления операций покупки/продажи драгоценного металла, депозитов с драгоценным металлом, поступлений/списаний драгоценного металла/валюты на/со счета(ов) UNALLOCATED в отделе оформления операций с драгоценными металлами Управления операций с драгоценными металлами Департамента иностранных операций Банка в рамках проводимых им в настоящее время сделок и документооборота и с учётом формирования сообщений в формате SWIFT».

Вроде всё описано как есть, но вы что-нибудь поняли? Налицо принцип «дымовой завесы», когда трудность восприятия текста пропорциональна длине фраз и слов, составляющих этот текст. После вдумчивой работы родился несколько другой вариант: «В отделе операций при Управлении операций с драгоценными металлами Департамента иностранных операций Банка:

  • осуществляют оформление сделок покупки или продажи драгоценного металла;

  • оформляют депозиты с драгоценным металлом;

  • производят регистрацию поступлений или списаний драгоценного металла на счета или со счёта UNALLOCATED при сделках и документообороте, описывающих сделки;

  • производят учёт формирования сообщений в формате SWIFT».

После переделки текст по крайней мере понятен. А вот другой образчик из руководства к программе по предоставлению путёвок в оздоровительные лагеря: «В списке родственников указанного сотрудника выбрать, активизировав курсором, нужного ребёнка; при необходимости - добавить ребёнка, используя кнопки навигатора». Интересно, как это можно добавить ребёнка (может быть, его родителям), используя кнопки навигатора? А если родители не согласятся добавлять ребёнка в семью с помощью кнопок навигатора? Мы часто пропускаем такого рода «ляпы», махнув на них рукой. Да нам вроде и так всё понятно. Между тем в деловом письме подобные огрехи недопустимы.

А что говорят отцы-законодатели?

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

Деловое письмо отличают следующие особенности.

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

  • Недопущение разговорных, просторечных, диалектных и жаргонных слов и оборотов.

  • Установка на стандартизацию языка при отображении типовых ситуаций делового общения («В соответствии с…», «В связи с…», «В целях…»).

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

    • преимущественное использование простых предложений или использование предложений, содержащих, как правило, однородные члены предложения;

    • активное употребление причастных оборотов и редкое – деепричастных (только устойчивые конструкции «Исходя из…», «Принимая во внимание…», «Учитывая, что…»);

    • активное использование страдательных конструкций и безличных форм («Представляется возможным…», «Было определено…»).

  • Использование оборотов или словесно-универсальных форм, что позволяет:

  1. не тратить время на поиск определений стандартных ситуаций;

  2. повысить информативность документа;

  3. облегчить восприятие и оценку информации.

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

А теперь рассмотрим основные ошибки при выборе слов.

  1. Не различение паронимов, близких по звучанию однокоренных слов, значения которых различны (например: «гарантийный - гарантированный», «командировочный – командированный», «представить – предоставить»). Паронимы различаются не только оттенками значений, но и способами грамматической связи с другими словами (например: «оплатить счёт - заплатить за что-либо»), а также стилистической окраской. Смешение паронимов является одним из наиболее грубых нарушений норм делового языка.

  2. Ошибки в употреблении синонимов, слов с одинаковыми или очень близкими друг к другу значениями, которые очень редко полностью тождественны друг другу, но различаются оттенками значений, лексической сочетаемостью, стилистической окраской (например: «возражать – противоречить»). Невнимание к оттенкам значений синонимов может привести к смысловой ошибке. Например, слово «дефект» может быть использовано только по отношению к техническим изделиям, а слова «изъян» и «недостаток» относятся к тому, что создано природой, и к общественной деятельности. Так же и слова «использовать», «выбирать», «применять» надо вставлять в текст в зависимости от контекста.

  3. Частичное совпадение значения слов, образующих словосочетания, ―  плеоназмы («памятный сувенир», «передовой авангард», «в апреле месяце»). Употребление плеоназмов в деловой речи нежелательно. Обратимся к книге «Думай о смысле» Ивана Чаплыгина, где приводится множество примеров неудачных выражений, в том числе и плеоназмов. В главе 21 читаем: «Например, автор хочет подчеркнуть, что решение принято бесповоротно и пересмотру не подлежит, и потому пишет «абсолютно окончательное решение», хотя прилагательное «окончательный» уже несёт в себе значение «абсолютности». То же касается затёртой до дыр фразы «исключительно по собственному усмотрению», где первое слово можно опустить, не потеряв ни капли смысла». Ещё хуже выражения «иметь важную роль» или «играть ключевое значение».

  4. Смысловой повтор при соседстве однокоренных слов ― тавтология («польза от использования», «явление проявляется»). Тавтологические повторы делают текст тяжёлым для восприятия. Простой случай смыслового повтора, изъятый из руководства пользователя: «…которые будут обновлять хранилище данных ежедневно, еженедельно, ежемесячно, либо в указанные дни». А вот более сложный: «Каждое автоматизированное рабочее место есть некоторая совокупность служебных обязанностей, реализуемых через технологические операции». Понятно, что совокупность служебных обязанностей реализуется через технологические операции, потому проще: «Исполнители на автоматизированном рабочем месте реализуют совокупность технологических операций». Ещё один совсем ненужный повтор: «Программный продукт обеспечивает выполнение функций автоматизации процесса сбора и анализа лог-файлов со следующих компонентов…». Вместо этого проще и понятнее: «Программный продукт автоматизирует сбор и анализ лог-файлов c…». А вот пример неоднократного повтора одного и того же слова в одном абзаце: «Метаданные обычно определяются как данные, которые описывают данные и другие структуры хранилища данных (объекты, бизнес-правила, процессы и пр.) В более общем определении метаданные – это информация о содержимом (контенте) хранилища данных, обеспечивающая пользователям возможность использования корпоративного хранилища данных в соответствии с их потребностями». Предоставляю возможность читателям самим попытаться преобразовать этот абзац в удобоваримый.

  5. Неправильное использование слова в новом значении с целью придать образность («маяки производства», «в соревновании лидирует квартет мастеров», «расширить географию поиска»). Пример из текста руководства ПО: «Отчёт о результатах проведения тестирования на проникновение в отношении внутренней сети компании N». Явная избыточность текста с целью придать ему непонятную образность. Проще и понятнее сказать так: «Отчёт о тестировании на проникновение во внутреннюю сеть». А вот пример использования красивого слова «потенциальный», которое поменяло весь смысл текста: «Приглашение для потенциальных партнёров банковской конференции». На самом деле должно звучать: «Приглашение стать партнёром банковской конференции», замена одного неправильного слова придало действительно необходимый смысл фразе.

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

  7. Употребление устаревших слов («обмер», «вышепоименованный»).

  8. Ошибки при использовании фразеологизмов. 

Фразеологизмы подразделяются на группы:

  • Фразеологическое сращение ― устойчивое словосочетание, общий смысл которого не может быть выведен из значений отдельных слов (идиома «Комар носа не подточит»).

  • Фразеологические единства ― общий смысл близок к смыслу входящих в фразеологизм слов, но не сводится к сумме их значений («Играть роль», «принимать меры», но ни в коем случае нельзя употреблять «предпринимать меры», «иметь важную роль» или «играть ключевое значение»).

Как правило, фразеологизмы в деловой речи многократно повторяются, принимая форму речевой формулы:

  • «в связи с (указанием, распоряжением, требованием)»;

  • «в соответствии с… (соглашением, договором, достигнутой договорённостью)»;

  • «в порядке оказания… (технической) … помощи»;

  • «принять во внимание…»;

  • «довести до сведения…».

Для деловой речи в качестве фразеологизмов употребляется так называемое расщеплённое сказуемое, то есть сказуемое + существительное («оказать помощь» ― для деловой речи, «помочь кому-либо» ― для бытовой).

Расщеплённые сказуемые широко проникают в деловую речь в связи с тем, что:

  • они не всегда имеют параллельные глагольные формы («оказать внимание», «установить порядок»);

  • значение расщеплённого сказуемого не всегда совпадает со значением соответствующего ему глагола («провести соревнования» - «соревноваться»), в сказуемых «программировать» и «составить программу» есть разные смысловые оттенки;

  • в расщеплённых сказуемых широко используются термины, точно квалифицирующие явления, особенно в юридической практике («вести следствие», «совершить наезд»).

Употребление фразеологизмов подчиняется определённым нормам. В случае их нарушения возникают ошибки:

  • изменение сочетания «глагол ― существительное» («одержать победу» ― правильно; «одержать успех» ― неправильно);

  • искажение состава фразеологизма в результате замены слова («ниже любой критики» ― неправильно, должно быть ― «ниже всякой критики») или изменения грамматической формы («покривил в душе» ― неправильно, должно быть ― «покривил душой»);

  • включение в текст служебного документа специальной лексики.

Специальная лексика – группы слов, относящиеся к определённым профессиям или видам деятельности. Они включают следующие группы слов.

  • Термины, значение которых строго обусловлено в пределах данной специальности, например, «сила» ― в физике, «абсцесс» ― в медицине, problem-oriented language (проблемно-ориентированный язык) ― в программировании. Следует использовать только нормированные термины, имеющиеся в государственных классификаторах и ГОСТах.

  • Профессионализмы ― профессиональные заменители терминов («кардан» ― карданное устройство, «окулист» ― офтальмолог, soft ― программа, программируемый).

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

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

Таблица 1. Жаргонные термины на основе английских и их русскоязычные синонимы

Жаргонный термин

Синонимы

Айпишник

IP-адрес компьютера

Ассоциативно

(лат. associatio - соединение), свойство операций, позволяющее восстановить последовательность их выполнения при отсутствии явных указаний на очерёдность при равном приоритете.

Апгрейдится

(англ. upgrade) ― обновлять, улучшать что-либо, наделять вещь новыми и более совершенными качествами.

Журналируемый

(англ. logging) ― автоматическая запись в хронологическом порядке операций, процесс, проводимый с оформлением журналов.

Задисэйблен

(англ. disabled ― выключить), заблокированный

Зарелизил (релиз)

(англ. release - версия) – выпуск в свет программного продукта (сам программный продукт).

Зафиксить

(англ. to fix - чинить, закреплять) ― прикреплять, установить, закрепить что-либо в определённом положении, запечатлеть, отразить что-либо с помощью записи, рисунка, фотографии.

Зеркалирование

(англ. port mirroring, SPAN ― аббр. от Switched Port Analyzer) ― дублирование пакетов одного порта сетевого коммутатора (или VPN) на другом. Создание зеркально-симметричных копий (mirror inversion) носителей информационных массивов.

Имплементация 

(англ. implementation) ― программная или аппаратная реализация какого-либо протокола, алгоритма, технологии

Инкреме́нт

(англ. increment) ― увеличение, операция во многих языках программирования, увеличивающая значение переменной.

Инкрементно

Обновление данных с помощью пошаговой процедуры

Кастомизация

(англ. to customize) ― настраивать, изменять,  приспосабливать

Квитование

(англ. quit — избавление, освобождение), освобождение от взаимной задолженности, квитирование ― подтверждение приёма-передачи структурной единицы информации. 

Кейс

(англ. case – случай, дело) –  многозначный термин, элемент программы, метода, предмет, используемый в определенной области.

Лайфхак

(англ. life – жизнь, hack - взлом) – новый метод, навык, повышающий производительность.

Митап

(англ. meet up – встреча на коротке) – тематические встречи

Отрефракторил код (Рефраторинг)

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

Паспортизирование

Составление технических паспортов

Пинги

(англ. ping), утилита для проверки целостности и качества соединений в сетях на основе TCP/IP, а также обиходное наименование самого запроса.

Приаттачить

(англ. attach ― прикреплять), присоединить файл к электронному письму

Релевантный

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

Свопинговый файл

(англ. swapping – обмен), файл подкачки, файл выгрузки задач, специальный файл на жёстком диске, в котором хранятся данные для быстрого доступа системы.

Снифить трафик

(англ. sniff – нюхать) – перехват потока данных между компьютерами

Трекингование

(англ. tracking), отслеживание.

Уникализация

Процесс оптимизации первоначального варианта по требуемым параметрам, повышение качества работы в целом: оригинальность, орфография, «вода», заспамленность и др.

Хардкор

(hardcore - жесткий, радикальный) – многозначный термин  (переводится как «мощная основа»), радикальное направление, сложные правила, жесткость в исполнении

Хинты

(англ. hint), подсказки, всплывающие подсказки

Эскалируемый

(англ. escalate ― нагнетать, обостряться), продлеваемый, продолжаемый

Юзабилити

(англ. usability) – возможность использования, показатель, насколько легко и удобно пользователю взаимодействовать с интерфейсом.

Юзкейс

(англ. use case - сценарий пользования) – сценарий взаимодействия пользователя с программным продуктом, иногда – примеры, казусы, ситуации.

Остановить процесс проникновения английских терминов в деловые тексты, тем более относящиеся к IT, практически невозможно, поскольку вся программная литература написана именно на этом языке. Кроме того, зачастую один короткий английский термин с трудом заменяется несколькими русскими словами. Вот пример из руководства пользователя, где замена на английский термин вполне уместна: «Список полей в формате UNIFACE List – пригоден к немедленному засовыванию в Valper DropDowna – очень удобно». Гораздо приятнее звучит: «Список полей в формате UNIFACE List удобно и быстро импортируется в Valper DropDowna».

Но бороться с жаргоном в деловой документации необходимо.

Существительные и прилагательные

Вызывают трудности следующие варианты написания.

  • У существительных мужского рода с окончаниями «е», «у» в предложном падеже единственного числа в деловом стиле следует использовать окончание «е», «у» ― в разговорном («в цехе ― в цеху»; «в отпуске ― в отпуску»).

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

Существуют следующие особенности использования прилагательных в деловых текстах.

  • Использование степеней сравнения прилагательных часто различаются стилистически. Употребляются простые и составные формы сравнительной степени («важнее ― более важный»). В деловой речи предпочтительнее составные формы, так как простые часто имеют отчётливую просторечную окраску («гибче», «ёмче»). Распространённая ошибка ― употребление слов «более», «менее» с простой формой сравнительной степени («более важнее», «менее серьёзнее», правильно ― «более важный», «менее серьёзный»), а сочетание «более лучше» ― неправильно, или просто «лучше» или «ещё лучше».

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

  • Употребление притяжательных прилагательных в целом нежелательно. Особенно в отношении одного лица или объекта (не «отцов костюм», а «костюм отца»). Если притяжательное прилагательное относится к группе объектов, то оно уместно («писательский труд», «корпоративный сбор»).

Глаголы, которые жгут сердца людей

При употреблении форм глагола нужно учитывать некоторые особенности. 

  • При образовании глаголов несовершенного вида с «о/а», суффиксом «ива», «ыва», часто встречаются параллельные формы: «обусловливать ― обуславливать», «сосредоточивать ― сосредотачивать»; «а» ― более применима для разговорных форм, «о» ― для книжного стиля.

  • В деловой переписке глаголы совершенного вида образуются при помощи приставки «за» ― «завизировать», «запротоколировать».

  • Параллельные формы прошедшего времени глаголов типа «возник», «прибег», «достиг» нежелательно употреблять с суффиксом «ну», особенно в женском и среднем роде («достигнула» ― неправильно, лучше ― «достигла»).

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

Местоимения, союзы и предлоги тоже важны

Личные местоимения

  • Неправильное употребление «он», «она», «оно», «они», когда местоимения могут быть соотнесены с несколькими предшествующими существительными, вызывает двоякое понимание текста, что является распространённой ошибкой. (Пример: «После присоединения фирмы «Неон» к корпорации «Фреон» ей было передано ценное оборудование» ― Непонятно, кому передано!). Употребление местоимений «его», «её», «их», «свой», «себя» при нескольких предшествующих существительных создает двузначность понимания.

  • Обороты типа: «Предлагаю явиться…», «Прошу уточнить…» и т.п. меняют свою стилистическую окраску, становятся менее категоричными, если употреблять местоимение «Вы» («Прошу Вас уточнить…»).

Притяжательные местоимения, сложные случаи

  • Употребление местоимения «В своём отчёте инспектор Петров…»; «В своей автобиографии…» создаёт избыточность фразы. В данном случае употребление местоимения «свой» является лишним.

  • Употребление местоимения «себя» в устойчивых словосочетаниях типа «Представлять себя на презентации …», «Microsoft Office представляет собой комплекс программ …», придаёт речи бытовой характер. Лучше ― «Представил на презентации …», «Комплекс программ Microsoft Office ― это …».

Союзы

  • Сложный союз «не только, но и». Каждая из частей должна находиться перед однородными членами сложносочинённого предложения. Если члены предложения употреблены с предлогом, то он повторяется перед каждым членом предложения. Например: «Не только для себя, но и для других».

  • Ошибка в замене союза «постольку поскольку» формой «постолько посколько».

  • Ошибочность в употреблении просторечного союза «потому как».

  • Сложный союз «как, так и» в технической документации следует употреблять с осторожностью, потому что он придает техническому языку литературный оттенок («в комплект оборудования входит как L3 коммутатор от компании TP-Link, так и повторитель PT-REPEATER-NM-1CE»).

Предлоги

  • Предлог «благодаря» необходимо отличать от предлога «из-за». Первый указывает на причину, способствующую чему-либо, второй ― причину, мешающую чему-либо. «Благодаря» требует дательного падежа существительного или местоимения. Употребление родительного падежа ― ошибка. Например: «благодаря поддержке», а не «благодаря поддержки».

  • Предлог «вопреки» требует дательного падежа, т. е. надо писать «вопреки указанию», а не «вопреки указания».

  • Ошибка в употреблении предлога «за счёт» вместо предлога «благодаря».

  • Предлог «по» не может указывать на цель действия и заменить предлог «для». Например: «Много делается для художественного воспитания детей», если употребить «по» ― это ошибка. Предлог «по» не заменяет предлог «из-за».

  • Предлог «под» не может заменять предлог «для», т.е. надо «банка для масла», а не «банка из-под масла» ― это просторечие. «Чехол для ноутбука», а не «чехол под ноутбук».

  • В деловой речи укоренилось употребление предлога «против» в значении «по сравнению». Пример: «ГОСТы серии 34. разработаны для регламентирования порядка создания автоматизированных систем и перечня нормативной документации к ним против ГОСТов серии 24, которые разработаны для регламентирования создания автоматизированных систем управления».

  • Предлог «согласно» требует дательного падежа, то есть «согласно приказу», а не «согласно приказа».

Логические основы анализа текста

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

Закон тождества

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

Пример фразы из технического описания: «Оборудование узлов цифровой сети АТМ обеспечивает возможность мониторинга оборудования вплоть до розетки абонента». Налицо логическая ошибка. Оборудование узлов цифровой сети никак не может обеспечить мониторинг. Для этого существует специальная программа, которая заложена в оборудовании (кстати, в чём заключается мониторинг вплоть до розетки абонента?).

Фраза из руководства пользователя: «Достаточно просто все принятые решения переложить с бумаги в жизнь, возможно дообучить персонал». Заключительная часть предложения не соответствует содержанию начальной части.

Вот ещё одна запутанная фраза: «MOLAP, будучи изначально ориентированным на хранение часто очень разреженных многомерных данных, имеет преимущество перед ROLAP-системами в плане скорости обработки и большей аналитической функциональности». Наверняка, указанное преимущество имеет место, но это преимущество требует внятного объяснения, поскольку не понятна связь между «разреженностью многомерных данных и большей аналитической функциональностью».

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

Приведу ещё пример одной учебной фразы, которую озвучил один из апологетов отечественной лингвистики: «Гло́кая ку́здра ште́ко будлану́ла бо́кра и курдя́чит  бокрёнка». Хотя мы понятия не имеем, кто такая «куздра», но совершенно ясно, что она напала на какого-то мифического бокра, да ещё и на его детёныша, то есть фраза логически построена так, что нам понятны описываемые действия. Очевидно, что, даже встретив в техническом тексте незнакомый термин, мы не должны мучиться, пытаясь разгадать смысл текста. Он должен быть ясен из общего построения, расположения подлежащих, сказуемых и других членов предложения, а разъяснение термина можно получить из словарей.

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

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

Закон противоречия

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

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

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

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

Одни из наиболее часто встречающихся скрытых противоречий – количественные противоречия. Например: утверждение: «Три игры – три победы с общим счётом 4:2. Таков итог выступления нашей футбольной сборной в турнире» – ошибочно, счёт должен быть 5:2, т.к. при трёх победах в трёх играх счёт 1:0, 2:1, 2:1. Поэтому в процессе правки документа необходимо проверять утверждения, в которых присутствуют количественные характеристики неявного типа, требующие сравнения ещё с чем-либо.

Закон исключённого третьего

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

Закон действует в следующих случаях.

  • Когда одно из суждений утверждает, а другое то же самое отрицает относительно единичного явления. Например: «Фирма выполнила план поставок», «Фирма не выполнила план поставок». Любой иной вариант типа: «Фирма выполнила план поставок не полностью» не должен заменять второе суждение.

  • Когда одно из суждений что-либо утверждает относительно целого ряда явлений, а другое это отрицает в отношении части явлений, входящих в этот ряд. Например: «Все фирмы нашего региона объединены в ассоциацию» и «Фирма «Квант» не вступила в региональную ассоциацию». Эти суждения противоречат друг другу, а третьего не дано.

Закон исключённого третьего предъявляет жёсткие требования к рассуждениям. Как только сталкиваются взаимоисключающие суждения, надо устранить неопределённость, выявить, какое суждение истинно, а какое ложно, и не искать истину в каком-либо дополнительном суждении.

Закон достаточного основания

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

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

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

Основные требования к доказательствам:

  • тезисы и аргументы должны быть ясными и точно сформулированы;

  • в ходе доказательства тезис должен быть неизменным;

  • тезисы и аргументы не должны быть противоречивы;

  • истинность аргумента не должна вызывать сомнений;

  • доказательство должно быть достаточным.

Пример рекламы из сферы ритейла: «Сроки вывода на рынок новых сервисов и услуг постоянно сокращаются. Это требует от инфраструктуры компаний максимальной скорости работы и адаптивности. На поддержание функционирования сети IT-специалисты тратят более половины своего времени».

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

А как быть с рубрикацией текста

Часто в документах используются списки, которые являются элементами рубрикации и облегчают восприятие сложного технического текста. Знаки препинания (точки и точки с запятой в конце элементов списка) при рубрикации вызывают затруднения.

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

Это можно проиллюстрировать примером.

«Подсистема функционирует на следующих технических средствах:

  1. Сервер БД Supermicro 6029P New, семейство процессоров 2 x Intel@ Xeon@ Scalable, сокет LGA 3647, RAM до 3 ТB DDR4 ECC REG, с HDD/SSD (корзина на 12/8 x 3,5″ дисков с возможностью горячей замены).

  2. Рабочие станции (по числу рабочих мест), каждая из которых имеет процессор с частотой не хуже 2 ГГц, оперативную память не менее 4 Гб, дисковый накопитель объёмом не менее 540 Гб, монитор с разрешением не менее 1640х980, сетевую плату.

  3. Сетевая разводка на тонком кабеле или на витой паре».

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

Пример: «В представленном экране формирования и печати документов составляется:

  • подтверждение контрагенту по сделке покупки/продажи бумаг;

  • телеграмма хранителю по бумагам».

Резюме

Как видите, с текстами документов не всё так просто. Можно посмеяться над фразой «Шёл дождь и два студента», если подобное проскочило в школьном сочинении, но в деловой документации такие формулировки нужно выжигать калёным железом (вот и я не удержался от фразеологизма).

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

Самое обидное, что читатель (в общем смысле этого понятия) уважительнее относится к малопонятным и заумным текстам, нежели к изложенным просто и ясно. Более того, статистика показывает, что статьи с тяжёлым языком цитируются чаще других. Как говорит народная мудрость: «Непонятно, но здорово!». 

Думаю, что никто не станет возражать, что технические документы всё-таки должны быть написаны простым, ясным, логичным языком, используя необходимое и достаточное количество специальных терминов.

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

Теги:
Хабы:
Всего голосов 42: ↑40 и ↓2+48
Комментарии12

Публикации

Информация

Сайт
lanit.ru
Дата регистрации
Дата основания
Численность
свыше 10 000 человек
Местоположение
Россия
Представитель
katjevl