Какой аналитик не хочет, чтобы его тексты воспринимались легко и образно, как картинки? Один мой коллега часто сравнивает текст со стеклом. Через чистое стекло человек сразу увидит всё, что происходит за ним; ему не нужно пытаться смотреть под другим углом и домысливать то, чего совсем не видно. Точно также и с текстом — если он написан понятно, читатель с первого раза правильно поймёт мысль автора, и ему не нужно будет перечитывать отдельные фразы и домысливать то, что не ясно.
Начну с того, почему я решила написать эту статью. Не так давно я получила не совсем аналитическую задачу — написать руководство пользователя. Поначалу я немного расстроилась, потому что задача была не интересной и длительной (несколько месяцев), но потом решила, что руководство пользователя — это отличная тренировка в точном изложении мыслей. В ходе работы над руководством я проработала несколько статей на соответствующую тематику и консультировалась с очень опытным аналитиком нашей компании – Алеком Конечным. В итоге я для себя вывела несколько правил, которыми я хотела бы поделиться с вами.
Логика изложения.
1. В первом предложении абзаца старайтесь передавать суть этого абзаца. Например, я сама часто мысленно благодарю автора, если смысл текста можно понять просто пробежав глазами текст.
2. При изложении новой мысли двигайтесь от общей информации к деталям. Частный случай этого правила: не начинайте с примеров. Если вы приводите пример до того, как сделать общее утверждение или определение, читателю сложнее осмыслить такую конструкцию. Сравните:
| Было | Стало |
| Требования вида «мне нужна система, которая бы увеличила эффективность работы моего отдела» могут являться стандартной практикой во время сбора требований. | Изначально требования могут быть выражены весьма смутно. Например, «мне нужна система, которая бы увеличила эффективность работы моего отдела». |
| Группа инженеров может быть должна периодически проверять и утверждать конструкторскую документацию в рамках дистрибуций. Такие группы в системе называются группами дистрибуции в системе. | Группа дистрибуции – это пользователи, которые должны выполнять сходные задачи в рамках одной дистрибуции.
Пример:Если определённая группа инженеров периодически проверяет и утверждает конструкторскую документацию, создайте для них группу дистрибуции. |
3. Когда классифицируете объекты, указывайте признаки, на которых эта классификация основывается. Сравните:
| Нотификации — это …
Есть два вида нотификаций: сообщения и напоминания. Сообщения отправляются после выполнения определённых команд. Напоминания же отправляются строго по расписанию. |
Нотификации это …
В зависимости от того, что влияет на отправление нотификации, они подразделяются на сообщения и напоминания. Сообщения отправляются, после выполнения определённых команд. Напоминания отправляются по расписанию. |
4. Стройте предложения по принципу «от известной информации к новой». Подробнее почитать можно в этой статье, в абзаце, где автор рассказывает про компоненты высказывания – тему и рему. Чаще всего по этой причине, условные предложения следует начинать с «если», а не с «то», т.к. обычно именно условия содержат известную информацию. Сравните:
| Ваш компьютер будет хуже защищен от вирусов и злоумышленников, если вы отключите брандмауэр Windows. | Если вы отключите брандмауэр Windows, ваш компьютер будет хуже защищен от вирусов и злоумышленников. |
| Нажмите на кнопку ОК, чтобы отформатировать жесткий диск. | Чтобы отформатировать жёсткий диск, нажмите кнопку ОК. |
5. Используйте союзные слова по назначению. Правильное употребление союзных слов, таких как: «если», «когда», «как только» может упростить понимание.
Почувствуйте разницу между союзамиЕсли и Когда:
| Когда посылка будет отправлена, получатель сможет осуществить своё действие. | Если посылка будет отправлена, получатель сможет осуществить своё действие. |
Во втором случае дистрибуция НЕ обязательно будет отправлена. Союз Если готовит нас к тому, что условие не обязательно осуществится. Сравните:
| Когда дистрибуция не содержит документов, она не может быть отправлена. | Если дистрибуция не содержит документов, она не может быть отправлена. |
Союз Как Только сразу даёт понять, что одно действие следует за другим. Сравните:
| Когда все задачи дистрибуции завершены, система отправляет контроллеру нотификацию. | Как только все задачи дистрибуции завершены, система отправляет контроллеру нотификацию. |
6. Повелевайте! Человек воспринимает повелительное наклонение лучше, чем безличные предложения. Сравните:
| Чтобы сконфигурировать напоминания, нужно задать условие и расписание. | Чтобы сконфигурировать напоминания, задайте условие и расписание. |
| Библиотека шаблонов нотификаций предназначена для упрощения и ускорения работы с нотификациями. | Чтобы настроить нотификации быстро и просто, используйте библиотеку шаблонов нотификаций. |
Прозрачность текста.
«Усложнения» в речи, такие как отглагольные существительные или причастные обороты, появились не просто так. Тем не менее, мы всё-таки порой усложняем там, где этого делать не стоит. Далее я привожу несколько правил, которые помогут убедиться в том, что усложнения действительно нужны.
1. Частое употребление пассивного залога — зло. То, что активный залог воспринимается лучше пассивного, является почти прописной истиной. Авторы этого руководства для разработчиков технической документации к программному обеспечениюсчитают, что имеет смысл дифференцировать употребление залоговых формследующим образом: активный залог применятьпреимущественно для обозначения действий физических лиц, пассивный — для обозначения действий, выполняемых программой. Сравните:
| После того как все задачи дистрибуции завершены, она должна быть переведена Контроллером в состояние «закрыта». | После того как все задачи дистрибуции завершены, Контроллер переводит её в состояние «закрыта». |
| Чтобы антивирусные базы могли загружаться программой из любого каталога, пропишите к ним путь в поле Х.
|
Чтобы программа могла загружать антивирусные базы из любого каталога, пропишите к ним путь в поле Х. |
2. По возможности превратите все отглагольные существительные, причастия и деепричастия в глаголы. Конструкции типа «мама мыла раму», просты и понятны даже детям. Если же действие прячется в существительном, прилагательном или наречии, то стоит убедиться, что это усложнение оправдано.
Отглагольные существительные довольно сложно воспринимать. Сравните:
| Конфигурирование нотификации включает в себя задание команды и дополнительного условия для неё. | Чтобы сконфигурировать нотификацию, укажите команду и дополнительное условие для неё. |
В подавляющем большинстве случаев они сигнализируют о наличии «канцеляризмов»:
| Система осуществляет проверку файла на следующие ошибки… | Система проверяет файл на следующие ошибки… |
| В процессе своего функционирования сервис нотификаций периодически обращается к …за … | Сервис нотификаций периодически запрашивает … у … |
Особое внимание надо обращать на парные отглагольные существительные– дело может доходить до смешного, например «наличие отсутствия».
Авторы упомянутого выше руководствасчитают, что отглагольные существительные всё-таки стоит использовать для действий, которыенужнопредставить как некоторый устойчивый, целостный, завершенный этап. Сравните:
| Приложение устанавливается от 10 до 20 минут.
|
Установкаприложения может занять от 10 до 20 минут. |
Причастия довольно редко встречаются в устной речи (проследите за своей устной речью — и вы в этом убедитесь), возможно, поэтому нам довольно сложно их воспринимать в тексте. Cравните:
| Нотификация отправляется на выборку объектов, определённую дополнительным “условием”. | Нотификация отправляется на выборку объектов. Эту выборку определяет дополнительное “условие”. |
| Microsoft Word — это программный продукт, предназначенный для редактирования текстов и обладающий высокоразвитым пользовательским интерфейсом | Программный продукт Microsoft Word предназначен для редактирования текстов. Онобладает высокоразвитым пользовательским интерфейсом. |
Деепричастные конструкции также могут усложнить речь. Если деепричастие не помогает выразиться лаконично и прозрачно, не употребляйте его.
3. Проверьте местоимения: они могут затруднять восприятие информации. Не следует использовать местоимения, там, где однозначно не понятно, что они заменяют. Сравните:
| В рецензии используют публицистический или научный стиль речи. Это зависит от цели, ради которой пишется рецензия. | В рецензии используют публицистический или научный стиль речи. Выбор стиля зависит от цели рецензии. |
Порядок в тексте.
1. Проверьте текст на гармоничность. Например, элементы списка должны начинаться похожим образом, так как это облегчает восприятие и сканирование текста, а также позволяет легче запомнить эти элементы. Сравните:
| В соответствии со своим предназначением контролы на интерфейсе сгруппированы в три области:
- Область навигации содержит… - В области управления находятся… - Дополнительную информацию Вы можете получить в области… |
В соответствии со своим предназначением контролы на интерфейсе сгруппированы в три области:
- Область навигации содержит… - Область управления … - Область дополнительной информации … |
2. Структурируйте текст форматированием: выделяйте примеры, замечания. Обратите внимание пользователей на действительно важные моменты.
3. Пишите однозначные количественные числительные словами – это правило русского языка. (Правила написания числительных в тексте можно почитать здесь).
Список дополнительной литературы
1. http://www.philosoft.ru/_subsites/tcportal/metaguide/
2. http://evartist.narod.ru/text14/08.htm
3. http://www.redaktoram.ru/articles2_view.php?id=20
4.http://usethics.ru/blog/lib/vis/
Автор: Елена Гунёва
Обсуждение на форуме: http://analyst.by/forum/materialy-saita/kak-sdelat-tekst-prozrachnym
