Справка пользователя, справочная система, или просто Help, – это важная составляющая любого профессионального программного продукта. В справке пользователь может моментально найти ответ на любой вопрос о программе без необходимости писать в ваш отдел технической поддержки.
Написание справки требует особой тщательности. Грамматические ошибки, неряшливый слог, непонятные формулировки воспринимаются как дефект самой программы и портят впечатление о продукте. Журналисты пишут отрицательные обзоры в прессе, а потребители делают свой выбор в пользу конкурентов. О важности качественного описания для программы мы уже писали в статье Как хорошо писать маркетинговые тексты.
В данной статье речь пойдет о типичных ошибках в справке пользователя и том, как их избежать. Нижеприведенные рекомендации не являются исчерпывающими. Используйте их вместе с теми правилами, которыми вы уже руководствуетесь при разработке справочной системы.
Итак, какие же ошибки часто встречаются в справке?
1. Нерациональное описание процедуры
В описании процедуры информация должна быть расположена наиболее рациональным образом с точки зрения ее восприятия пользователем. Это значит, что сначала вы сообщаете, где пользователь должен выполнить действие, а уж затем – что он должен сделать (нажать, открыть, выбрать).
Например:
Неправильно: Select Open from the File menu.
Правильно: In the File menu, select Open.
2. Запись многошаговой процедуры одним предложением
Автор справки часто пытается описать сложную процедуру одним предложением. Для того, чтобы описание процедуры было четким и ясным, необходимо разбить длинное предложение на шаги.
Например:
Неправильно:
To select the type of the Distributor, click the Create button, and the floating window will open.
Правильно:
To select the distributor type:
- Click the Create button.
- On the Create window, select the distributor type.
- Click OK to save the selection.
3. Неправильное определение шагов
Сложная процедура состоит из нескольких шагов. Каждый шаг должен содержать действие и его результат. Однако часто можно встретить описания, в которых и действие, и результат представлены как отдельные шаги. Это неправильно.
Например:
Неправильно:
- Select the Phonebook tab.
- The Phonebook window opens.
- Click a contact.
- The contact profile opens
Правильно:
- Select the Phonebook tab.
The Phonebook window opens. - Click a contact.
The contact profile open
Или так:
- Select the Phonebook tab.
- On the Phonebook window, click a contact.
4. Название кнопок в кавычках
В справке пользователя название кнопки часто ставят в кавычки. Однако это считается пережитком прошлого, когда у пишущих машинок не было другого способа форматирования текста кроме кавычек и подчеркивания. Лучше всего название кнопки писать малыми прописными или выделять жирным шрифтом.
Например:
Неправильно: The “Remove” button removes a file from the list.
Правильно: The REMOVE button removes a file from the list.
Правильно: The Remove button removes a file from the list.
Кстати, иногда можно встретить неправильный порядок слов в написании названия кнопки: имя кнопки пишут после слова «button».
Например:
Неправильно: The button New enters a new transaction.
Правильно: The New button enters a new transaction.
5. And / Or
Не используйте комбинацию «and / or» в предложениях. Она затрудняет восприятия текста, заставляя пользователя перечитывать предложение еще раз. Вместо «and / or» используйте «… or… or both».
Например:
Неправильно: You can convert a file to AVI and/or MP3.
Правильно: You can convert a file to AVI or MP3, or both.
6. Неправильное использование терминов
Неопытный автор часто допускает ошибки в использовании терминов.
Например:
Неправильно: Press the New icon to create a new project..
Правильно: Click the New icon to create a new project.
Глагол «press» означает нажатие клавиши на клавиатуре, а «click» – нажатие кнопки или значка в окне программы при помощи щелчка мышью.
7. Будущее время
Часто встречаются описания, в которых отклик программы на действие пользователя передается в будущем времени. Например, «When you click the OK button, the program will start the conversion». Это неправильно. Будущее время заставляет читателя волноваться и задавать ненужные вопросы: «Когда начнется конвертация?», «А что, если не начнется?» Почему пользователи задают такие вопросы? Все очень просто.
Глагол “will”, который сейчас используется для выражения будущего времени, изначально имел форму “willan” и являлся модальным глаголом, выражающим желание или волеизъявление. Иногда «willan» использовался, когда люди говорили о своих планах на будущее, т.к. в древнеанглийском языке специальной формы для передачи будущего не было. Со временем “willan” превратился в “will”, но до сих пор он сохраняет дополнительный оттенок волеизъявления. Например, значение волеизъявления прослеживается во фразе «The pen won’t write» (рус. – «Ручка не хочет писать»).
Так вот, когда мы читаем предложение «When you click the OK button, the program will start the conversion», глагол «will» выражает не только будущее, но и свое модальное значение волеизъявления. Получается – программа «захочет» начать конвертацию. А если не «захочет?» Чтобы избежать неоднозначности в описании процедуры используйте настоящее время.
Неправильно: When you click the OK button, the program will start the conversion.
Правильно: When you click the OK button, the program starts the conversion.
8. Жаргон
Стиль справки пользователя должен быть нейтральным. Использование стилистически окрашенных слов отвлекает пользователя и является стилистической погрешностью, которую следует избегать.
Неправильно: Kill the app.
Правильно: Close the application.
Неправильно: Hit the Search button.
Правильно: Click the Search button.
9. Сокращения
В справке пользователя следует избегать сокращений и аббревиатур.
Например:
Неправильно: approx.
Правильно: approximately
Неправильно: e.g
Правильно: for example
Исключением может быть только “etc.”
Название из нескольких слов не следует сокращать, если оно используется в тексте только один раз. Однако, если оно употребляется несколько раз, то при первом упоминании в тексте следует писать полное название и аббревиатуру в скобках. Далее по тексту используйте аббревиатуру.
Например:
Правильно:
Oxygen Software today introduces an enhanced version of its Oxygen Phone Manager II (OPM II) for Nokia and Vertu phones. The biggest change in OPM II is tested quality support for groundbreaking Series 40 5th Edition of Nokia phones, whose posh look and cool features have won the hearts of millions of people.
Вывод
При написании справки необходимо стремиться к ясности, точности и краткости. Для этого необходимо глубокое знание основ грамматики и стилистики. Плохо написанная справка может вызвать дискомфорт или раздражение у пользователя и повлиять на его выбор в пользу вашего конкурента.
Надеемся, что наши рекомендации помогут сделать ваши тексты более грамотными, что непременно улучшит их восприятие пользователями.
Нужна помощь?
Вы можете заказать создание Help-справки у нас. С примерами наших справок можно ознакомиться в Портфолио.