Советы как подготовить справку пользователя для ПО на английском

    Привет! Сегодня мы открываем блог на Хабре. Наша специализация – переводы на английский язык, написание и рассылка пресс-релизов в Рунете, а также создание справочных систем для ПО. За несколько лет работы накопились некоторые знания, которыми хотим поделиться с вами. Надеюсь, что блог будет вам полезен. Желаю приятного прочтения и жду вас в постоянных посетителях.

    image

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

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

    Итак, какие же ошибки часто встречаются в справке пользователя?

    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, follow these steps:

    1. Click the Create button.
    2. On the Create window, select the distributor type.
    3. Click OK to save the selection.

    3. Неправильное определение шагов

    Сложная процедура состоит из нескольких шагов. Каждый шаг должен содержать действие и его результат. Однако часто встречаются описания, в которых и действие, и результат представлены как отдельные шаги. Это неправильно.

    Например:

    Неправильно:

    1. Select the Phonebook tab.
    2. The Phonebook window opens.
    3. Click a contact.
    4. The contact profile opens

    Правильно:

    1. Select the Phonebook tab.
    The Phonebook window opens.
    2. Click a contact.
    The contact profile opens.

    Или так:

    1. Select the Phonebook tab.
    2. 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.

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

    Иван PR

    21,00

    Компания

    Поделиться публикацией
    Комментарии 22
      0
      Некоторые пункты помогли мне :)
        +4
        Я бы ещё добавил, что тому, кто пишет текст необходимо хотя бы минмально разбираться в предметной области и терминологии.

        Случай из реальной жизни: один наш англоязычный клиент очень долго пытался понять, что означает выражение «translate of the string». Только потом поняли, что, на самом деле, это перевод строки. В смысле, line break.
          0
          Полностью с вами согласен. Терминологию обязательно нужно знать.
            0
            translate — глагол. Даже с неправильным значением слова перевод должно быть «translation of the string». В вашем случае перевод делал либо робот, либо какой-то совсем неграмотный человек.
            ЗЫ: ясные печеньки.
              +1
              Я, действительно, сформулировал негрмотно. Конечно же, было существительное translation. Переводчик был грамотный и квалифицированный. С инъязом за плечами. Английский знал — это факт. Просто не учитывал специфику.
            +4
            1. Posh — по-вашему, не «стилистически окрашенное» слово? www.askoxford.com его характеризует как informal.

            2. «won the hearts of millions of people» — близко к кальке с русского.

            Просто «of millions» как-то кошернее :)))

            3. И насчет e.g. не могу согласиться…

              0
              Только заметил, что последний пример из маркетингового текста взял, а не из справки… Сорри. В руководстве пользователя слова типа «posh» конечно же не используют. Плюсануть не могу — кармы не хватает :)
              +9
              Гиперссылка с «написание и рассылка пресс-релизов в Рунете» на ваш сайт — это то, ради чего статья писалась :)

              Неприлично на Хабре так неприкрыто заниматься SEO.
                –1
                Надеюсь, меня после этого в тюрьму для SEOшников не посадят :) Благодарю за замечание. В следующий раз буду держаться в рамках приличия.
                +1
                В пункте 4 должно быть отсутствующее сейчас выделение жирным в соответствующих примерах.
                  0
                  Исправил, благодарю.
                  +1
                  Хороший солидный «мясной» пост. Спасибо большое.

                  Хорошо бы follow-up сделать: структура документации или что-то в этом роде. Продолжить тему, так сказать.
                    0
                    Согласен. Думаю, что будет продолжение — структура справочной системы и возможно обзор 1-2 программ для создания руководства пользователя (если это интересно).
                    0
                    Почему Help на клавише Enter, а не F1, что уже давно стало стандартом?

                    По поводу кнопок я бы ещё поспорил. Мне как раз удобнее читать названия кнопок, выделенные кавычками. На худой конец — курсивом. Обозначение кнопки заглавной буквой — грамматически не верно, потому что «Click the Search button» читается как «нажмите на великую и неповторимую кнопку Поиска». Есть элементарные правила, что именно должно начинаться с заглавной буквы.

                    Статья, может быть, пригодится для начинающих, кто не имеет опыта деловой переписки и написания инструкций. Но в ней слишком много очевидных огрехов. Например, где правило №0, которое звучит как «каждая последовательность действий в инструкции описывает иллюстрацию»?
                      0
                      «нажмите на великую и неповторимую кнопку Поиска» — спорное утверждение.
                        0
                        Search с большой буквы, потому что это название
                        0
                        Неправильно: 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.

                        Оооочень спорное утверждение. Какие предпосылки для этого? Имхо кавычки здесь как нельзя кстати, особенно если название кнопки содержит текс, который может быть прочитан как часть предложения о ней.
                          0
                          Например, в Microsoft Manual of Style for Technical Publications названия кнопок в инструкциях без кавычек:

                          +1
                          Например:

                          Неправильно: Select Open from the File menu.
                          Правильно: In the File menu, select Open.


                          не согласен. первый вариант более правильный с точки зрения построения фразы по-английски. второй вариант «русский». а вобще в данном случае самым верным было бы select menu File > Open…

                          «каждая последовательность действий в инструкции описывает иллюстрацию»


                          тогда уж каждое действие в последовательности действий описывает иллюстрацию. а точнее иллюстрация описывает действие
                            0
                            Select File > Open… — согласен.
                            0
                            Спасибо, полезна и для русского языка — когда в статье нужно описать последовательность действий для выполнения поставленной цели.
                              0
                              И вам спасибо за отзыв, Антон.

                            Только полноправные пользователи могут оставлять комментарии. Войдите, пожалуйста.

                            Самое читаемое