Документация на английском языке: советы начинающим
Сегодня мы подвели итоги конкурса «Конёк документатора». Победители награждены призами, а лучшие работы мы опубликуем на нашем сайте.
Представляем вашему вниманию работу, занявшую 1 место: «Документация на английском языке (советы начинающим)». Автор – Софья Новикова, технический писатель в компании «Икстенс», г. Новосибирск. Пунктуация и орфография автора сохранены.
Так получилось, что весь мой опыт работы техническим писателем приобретался в компаниях, работающих с иностранными клиентами. Поэтому писать документацию мне приходилось преимущественно на английском языке. Хотелось бы поделиться опытом с теми техническими писателями, кто только начинает писать англоязычную документацию либо переводить русскоязычную документацию на английский язык. Конечно, хорошее знание английского языка – это первое и необходимое требование для достижения успеха, но недостаточное. Умение писать техническую документацию на русском языке так же может оказаться хорошим подспорьем, однако в англоязычной документации есть свои особенности, которые следует учитывать. Я расскажу об основных особенностях, которые мне удалось узнать за время своей работы.
Стандарты
Первый совет: перед началом написания документации ознакомиться с существующими стандартами.
Правильное написание элементов интерфейса
Прежде всего, стоит ознакомиться со стандартными наименованиями элементов интерфейса на английском языке и правилами их описания. Например:
- «Check box» пишется раздельно, «Drop-down» – через дефис, а «ToolTip» – слитно
- «Click the button», но «Press the key»
- «Select the check box», а не «Check the box»
Самый лучший источник информации по стандартам – Microsoft Manual of Style, на данный момент актуально четвёртое издание: http://www.microsoft.com/learning/en-us/book.aspx?id=15053. Этот документ регулярно переиздаётся, так что следите за обновлениями.
Стандартные названия глав документации
Если вы пишете руководство пользователя (User Guide), разумно использовать в структуре названия глав, привычные для пользователей, говорящих на английском языке. Например:
- Welcome to … (Введение).
- Feature Highlights (Обзор характеристик программного продукта)
- What’s New (Новые характеристики)
- Getting Started (Быстрый старт)
- Restrictions and Limitations (Список ограничений)
- Troubleshooting Tips (Решение проблем)
Набор глав может и отличаться от набора приведённого выше. Советую найти в интернете руководство к какой-либо известной программе, разработанной иностранной компанией, и обратить внимание на названия её глав. Ещё лучше – наметить структуру документа заранее и посоветоваться с носителями языка (если, конечно, есть такая возможность). К примеру, иностранные партнеры нашей компании очень помогли мне в построении нужной структуры документов и выборе нужных названий.
Стиль документации
Требования к стилю изложения англоязычной документации – такие же, как и к стилю изложения русскоязычной документации: структурированность, строгость, детальность, лаконичность, дружелюбный и авторитетный тон. Но следует помнить, что недостаточно хорошее знание английского языка может привести к невольному появлению чересчур авторитарного тона или напротив — чересчур фамильярного. Неаккуратный перевод сразу бросается в глаза читателям, говорящим на английском языке и снижает впечатление от технической документации.
Как называть пользователя
Лучше всего обращаться к пользователю во втором лице, в повелительном наклонении:
- Click the «Add» button.
- Please note that the file should have a correct format.
- This window allows you to configure the main settings of the system.
Однако, если требуется написать о пользователе в третьем лице (к примеру, при описании действий пользователя в инструкции дял администратора сайта), то следует избегать местоимения «he», т.к. оно указывает на половую принадлежность. Лучше употреблять существительные: «user», «administrator», «operator». Если не удаётся избежать употребления местоимения третьего лица единственного числа, то следует применять сочетание «he/she». Например:
- When the user submits the form, he/she gets the access to all the system functionality.
Should or Must?
При описании действия, которое пользователь должен произвести, используются модальные глаголы «should» и «must». Грань между их значениями весьма тонка. Однако в обращении к пользователю следует по возможности избегать словосочетания «you must» , т.к. это звучит излишне авторитарно. В большинстве случаев предпочтительно словосочетания «you should», т.к. это более вежливая форма указания.
- You should avoid using long file names for better work with the system.
- For correct work of the program you should previously install the special software.
Однако, когда требуется особо подчеркнуть необходимость действия (для критичных действий) – допустимо употребление словосочетания «you must».
- You must fill all the required fields to continue working.
Артикли
Артикли – это важный элемент любых англоязычных текстов, и русскоговорящие писатели довольно часто допускают ошибки в их использовании. Здесь, конечно, можно дать общий совет – изучать правильное употребление артиклей в английском языке. Но хочется особо упомянуть два момента связанных с артиклями в технической документации:
Артикли в заголовках
В заголовках технической документации обычно используется капитализация всех значимых слов. Артикли в заголовках используются редко, но если же используются — то никогда не пишутся с заглавной буквы, если только не используются в начале заголовка. Например:
- How to Add a New File
- Main Concepts of the System
Артикли в описаниях управления элементами интерфейса
Если вы описываете действие с именованным элементом интерфейса, например, нажатие на кнопку «Send», допустимы два варианта:
- С использование названия элемента («button») – в этом случае используется артикль «the» перед именем элемента:
Click the «Send» button. - Без использования названия элемента – в этом случае артикль не нужен:
Click «Send».
Употребление иностранных слов
Если проявить неаккуратность при использовании терминологии, пользователи могут счесть Вас недостаточно квалифицированным специалистом. Вот некоторые правила, которых следует придерживаться в использовании англоязычной терминологии:
Специальные термины
Обращайте внимание на перевод специализированной терминологии. Вот примеры переводов специализированных терминов: операционная система – operating system (и никак иначе, не operational system, operate system и т.п.), информационная система – information system.
Если возникают сомнения в использовании того или иного термина – сверяйтесь со словарём или поищите в интернете аналогичный пример в англоязычной документации.
Ложные друзья переводчика
Имейте в виду наличие так называемых «ложных друзей переводчика». Это слова в иностранном языке, которие похожи на слова в родном языке, но имеют другой смысл. Вот примеры таких слов:
- accurate – точный
- activity – деятельность
- actual – действительный, реальный, фактически существующий
- complex – сложный
- concurrent – одновременный
- control – управлять
- data – данные
- audience — аудитория
В заключение, хочется посоветовать, при наличии возможности, давать свою документацию на проверку носителям языка – это помогает прояснить множество вопросов и существенно улучшить качество документации.
Тэги: английский язык, конкурс, советы, стиль
- API
- DITA
- Flare
- HTML
- MadCap
- MS Word
- XML
- Алисса Фокс
- Марк Бейкер
- ПроТекст
- Том Джонсон
- анализ
- блоги
- веб-контент
- видеоролики
- единый источник
- изображения
- инструкции
- инструменты
- исследование
- качество контента
- командная работа
- конференции
- локализация/перевод
- минимализм
- навыки
- обучение
- опыт
- организация работы
- продвижение
- профессия
- редактирование
- роли
- советы
- стиль
- структурированное писательство
- теория документирования
- управление контентом
- форматирование
- форматы
- ценность контента
- эджайл
- эффективность
- юмор