Русский /

Блог

Опыт технического писателя. С примерами типа «До» и «После».

Хочу поделиться опытом применения в русском языке правил, которым обучают технических писателей в США и которые применяются в стайлгайдах зарубежных компаний, в том числе у заказчиков First Line Software (корпорации Quest, Dell).

Эти правила помогают формулировать мысль в понятной и краткой форме.

 
Скачать Спецификацию ASD-STE100 – http://www.asd-ste100.org/request.html

Подробнее про controlled language – например, http://en.wikipedia.org/wiki/
Controlled_natural_language
 (на английском).

Вариант правил УТР и ПО, которое автоматизируют их применение, от компании ТехноRUS http://www.technorus.ru/

Упражнения на укладывание мысли в простую форму – для английского языка и от стэндфордского университета – https://www.youtube.com/watch?v=X7Q6Ifr3gh0

Появление этих правил в английском языке во многом связано с понятием controlled language («контролируемый язык») и со Спецификацией документирования ASD-STE100. Несмотря на то, что правила сформулированы для английского языка, они набирают популярность во всем мире. Есть попытки русифицировать их в виде «упрощенного технического русского языка» – УТР.

Поделюсь своей рабочей версией правил УТР. В тексте привожу примеры с объяснениями, как с помощью «упрощенного технического русского» сложные формулировки становятся проще, а длинные – сокращаются. (Хотя последнее – когда как ;-)

Хочу отметить, что примеры из колонки «Было» – это не результат неправильного использования языка, а, чаще всего, результат того, что текст не был вычитан, на его редактирование не было заложено время. Варианты из колонки «Стало» не эталон, а мой вариант, как сделать исходник более простым для восприятия и коротким.

Правило 1. Оставляйте в предложении одно-два смысловых ядра

Когда начинаете утопать в «которая», причастных оборотах, попробуйте разбить мысль на смысловые ядра. И оформить каждое – в отдельное предложение. Это же правило помогает, когда просто тяжело сформулировать мысль: выделите смысловые ядра и составьте из них подлежащее и сказуемое.

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

Правило 2. «Упаковывайте» основную мысль в подлежащее и сказуемое

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

БылоСтало
На настоящем этапе осуществляется выбор типа формируемого параметра этого файла, а также вносятся коррективы в предполагаемое содержание файла.ОБЪЯСНЕНИЕ: Осмысляя это предложение, мы интуитивно переделываем его по схеме КТО-ТО + ДЕЛАЕТ ЧТО-ТО. И тогда получается, что «на настоящем этапе» задают тип параметра файла и редактируют его содержание. На данном этапе пользователь задает тип параметра этого файла, а также может изменить содержание файла.
Функционал добавления нового клиента доступен в двух вариантах: при создании записи на прием к мастеру и непосредственно из вкладки «Клиенты».ОБЪЯСНЕНИЕ: Грамматическая основа предложения – «функционал» «доступен», а основная мысль предложения – как добавить нового клиента. Значит, именно эти слова и должны составить подлежащее и сказуемое предложения. Добавить нового клиента можно или в окне добавления записи к мастеру, или на вкладке «Клиент».
Признаком установления соединения является отображение указанного адреса в текстовой части закладки главного окна.ОБЪЯСНЕНИЕ: Здесь мысль предложения все-таки не то, что «отображение являетсяпризнаком », а что если соединение установлено успешно, то появится специальная иконка. Когда соединение будет установлено, указанный адрес появится в текстовой части закладки главного окна.
Окно «Установить сессию» предназначено для прекращения текущей сессии, выполняемой с правами отображенного в окне пользователя, и открытия сессии с пользовательскими правами другого уровня. Используйте окно «Установить сессию», чтобы сменить текущего пользователя на пользователя с правами другого уровня.
Если у требования поле «Содержание на англ.» не заполнено, в соответствующей колонке появляется запись «Нет содержания на англ.». Запись «Нет содержания на англ.» означает, что у требования поле «Содержание на англ.» не заполнено.

Правило 3. Пусть подлежащее обозначает лицо, выполняющее действие

Оформляя смысловое ядро, старайтесь, чтобы подлежащее обозначало лицо, выполняющее действие, а сказуемое – действие, которое выполняет это подлежащее, а не действие, которое выполняется над подлежащим. Читающий все равно переделывает такие предложения в схему «КТО-ТО +ДЕЛАЕТ ЧТО-ТО».

БылоСтало
Вам откроется две таблицы одна под другой со списками специализаций и категорий.ОБЪЯСНЕНИЕ: «Вам откроется» – лишнее. Найдем в выражаемой мысли «КТО/ЧТО» и «ЧТО ДЕЛАЮТ» и составим из этого предложение. Специализации и категории отобразятся в соответствующих таблицах.

Правило 4. «Больше трех существительных не собирать»

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

БылоСтало
Специализации в системе используются для определения возможности предоставления тех или иных услуг сотрудниками.ОБЪЯСНЕНИЕ: «Определения возможности предоставления» утяжеляют текст. Заменим их на «определяют» Специализации определяют набор услуг, которые может предоставлять сотрудник.
Для начала процедуры регистрации Чтобы зарегистрироваться
Осуществляет защиту Защищает
Необходимо ввести Введите

Правило 5. Удаляйте то, что не несет смысла

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

БылоСтало
На выполнение данной процедуры требуется 2-3 минуты. В зависимости от особенностей конфигурации может потребоваться и больше. Как правило, процедура занимает не более 3-4 минут.
В зависимости от типа файла действия по настройке его параметров будут различными, что связано со спецификой текстового или напротив графического представления данных. Настройка параметров файла зависит от типа файла – графического или текстового.
Нажмите «КНОПКА» откроется панель справа с подробной информацией по выбранному требованию, включая дополнительные свойства требования. Чтобы увидеть дополнительные свойства выбранного требования, нажмите «КНОПКА».
Для перехода к функции подключения сервисов необходимо, находясь в личном кабинете, перейти к разделу Мои сервисы. Подключить сервисы можно в разделе «Мои сервисы» в Личном кабинете.

Правило 6. Перечисления и перечни – списком

На письме структурируйте информацию, чтобы ее легче было воспринимать.

  • Перечисления через запятую – лучше оформить буллитированным списком.
  • Абзац, описывающий последовательность действий, – оформите нумерованным списком.
БылоСтало
Для начала процедуры регистрации требуется запустить приложение и пройти по ссылке «Зарегистрироваться», расположенной в верхнем правом углу главной страницы сайта. Чтобы зарегистрироваться:
  1. Запустите приложение.
  2. В верхнем правом углу главной страницы сайта нажмите «Зарегистрироваться».

 

Инна Якименко