Как писать кратко и понятно
Представляем статью Инны Якименко, эксперта по документированию компании First Line Software (г. Санкт-Петербург), посвящённую упрощённому техническому языку.
Поделюсь своим опытом технического писателя, как уложить свою мысль в краткую и легко воспринимаемую форму.
Сертифицируясь по своей специальности в американском университете, я познакомилась с правилами написания и редактирования технических текстов, которые применяют зарубежные специалисты по технической коммуникации.
Появление этих правил во многом связано с движением controlled language («контролируемый язык») и стандартом документирования ASD-STE100. В настоящее время есть попытки русифицировать эти правила в виде «упрощенного технического русского языка» – УТР.
Поделюсь своей рабочей версией этих правил. «Рабочей» — именно потому, что она помогает мне в работе: помогает сформулировать мысль в понятной и, как правило, краткой форме. Также привожу примеры, как с помощью этих правил сложные формулировки получается сделать проще для восприятия, а длинные – сократить. (Хотя последнее – когда как 😉
Правило 1. Не более одного-двух смысловых ядер на предложение
Когда начинаешь утопать в «которая..» и причастных оборотах, попробуй разбить мысль на смысловые ядра. И оформить каждое — в отдельное предложение.
Пример:
Было |
Стало |
Продажи с удаленным участником доступны только при типе продаж «Удаленные» и подразумевают, что до момента старта продаж в участник может подать «Удаленные продажи с ценой», декларируя ту цену, за которую он желает продать товар. | Продажи с удаленным участником — это такие продажи, когда участник до начала продаж заявляет цену, за которую желает продать товар.Внимание! Продажи с удаленным участником доступны только при типе продаж «Удаленные».Чтобы участвовать в продажах с удаленным участником:1) Подайте «Удаленные продажи с ценой».2) … |
Правило 2. Основная мысль в подлежащем и сказуемом
Формулируйте свою мысль так, чтобы смысловое ядро содержалось в подлежащем и сказуемом.
Примеры:
Было |
Стало |
На настоящем этапе осуществляется выбор типа формируемого параметра этого файла, а также вносятся коррективы в предполагаемое содержание файла. | На данном этапе пользователь задает тип параметра этого файла, а также может изменить содержание файла. |
Если у требования/заголовка поле «Содержание на англ.» не заполнено, в соответствующей колонке появляется запись «Нет содержания на англ.». | Запись «Нет содержания на англ.» появляется у требований/заголовков с пустым полем «Содержание на англ.». |
Правило 3. Активный залог
Оформляя смысловое ядро, старайтесь, чтобы подлежащее обозначало лицо, выполняющее действие, а сказуемое – действие, которое выполняет это подлежащее, а не которое выполняется над подлежащим. То есть старайтесь использовать активный залог вместо пассивного. Когнитивисты доказывают, что активный залог легче воспринимать, чем пассивный.
Примеры:
Было |
Стало |
При запретительном сигнале запрещается движение в сторону, указанную стрелкой на сигнале. | Сигнал запрещает двигаться в сторону, указанную стрелкой сигнала. |
Правило 4. «Больше трех существительных не собирать»
Осмыслять последовательность из трех существительных — кто-кого-чей — не всегда легко, поэтому заменяйте такие последовательности глаголом или старайтесь «больше трех не собирать» ;-).
Примеры:
Было |
Стало |
Для начала процедуры регистрации | Чтобы зарегистрироваться |
Осуществляет защиту | Защищает |
Правило 5. Удалять то, что не несет смысл.
Удаляйте то, что повторяет смысл сказанного или не добавляет информации.
Примеры:
Было |
Стало |
В зависимости от типа файла действия по настройке его параметров будут различными, что связано со спецификой текстового или напротив графического представления данных. | Настройка параметров файла зависит от типа файла – графического или текстового. |
Нажмите «КНОПКУ» откроется панель справа с подробной информацией по выбранному требованию, включая дополнительные свойства требования. | Чтобы увидеть дополнительные свойства выбранного требования, нажмите «КНОПКУ». |
Для перехода к функции подключения сервисов необходимо, находясь в личном кабинете, перейти к разделу Мои сервисы. | Подключить сервисы можно в разделе «Мои сервисы» в Личном кабинете. |
На выполнение данной процедуры требуется 2-3 минуты. Хотя в зависимости от конфигурации может потребоваться и больше. | Как правило, процедура занимает не более 3-4 минут. |
Правило 6. Перечисления и перечни – списком
На письме структурируйте информацию, чтобы ее легче было воспринимать. Например:
- Перечисления через запятую – лучше оформить буллитированным списком.
- Абзац, описывающий последовательность действий, – оформите нумерованным списком.
Пример:
Было |
Стало |
Для начала процедуры регистрации требуется запустить приложение и пройти по ссылке «Зарегистрироваться», расположенной в верхнем правом углу главной страницы сайта. | Чтобы зарегистрироваться:
|
Тэги: минимализм, опыт, советы, стиль, УТР
- API
- DITA
- Flare
- HTML
- MadCap
- MS Word
- XML
- Алисса Фокс
- Марк Бейкер
- ПроТекст
- Том Джонсон
- анализ
- блоги
- веб-контент
- видеоролики
- единый источник
- изображения
- инструкции
- инструменты
- исследование
- качество контента
- командная работа
- конференции
- локализация/перевод
- минимализм
- навыки
- обучение
- опыт
- организация работы
- продвижение
- профессия
- редактирование
- роли
- советы
- стиль
- структурированное писательство
- теория документирования
- управление контентом
- форматирование
- форматы
- ценность контента
- эджайл
- эффективность
- юмор