КомпанияУслугиОбучениеСервисы

Как писать документацию по-английски?

Версия для печати

Как писать документацию по-английски?

Разработка ассоциации tekom: методическое пособие для авторов, пишущих на неродном английском

Мария Алешина, 2015

Библиографическая ссылка

Guideline. Rule-Based Writing—English for Non-Native Writers. — Stuttgart: tekom, 2014. — 115 с.

ISBN 978-3-944740-05-8

Проблема адекватности текста

Отечественная система образования зачастую сводит изучение английского языка к освоению лексики и грамматики. Практика показывает, что для полноценной коммуникации на английском языке этих знаний недостаточно. В лучшем случае они позволяют говорящему (или пишущему — далее мы будем обсуждать только письменную речь) сформулировать мысль, не нарушая грамматических правил. Однако из-за неудачного выбора слов и синтаксических конструкций его текст может выглядеть для носителя английского языка чуждо и вычурно. Вред от этого двойной: во-первых, такой текст сложнее для понимания, во-вторых, он плохо сказывается на репутации его автора.

Например, фразу:

    Check the presence of Settnings folder and create it if there is no such folder.

можно смело назвать «калькой» с русского, тогда как фраза:

    Create Settnings folder or make sure that it already exists.

смотрится намного привычнее для англоязычного читателя. Мы вернёмся к этому примеру в конце статьи, чтобы формализовать разницу между этими двумя фразами.

Существует ли способ овладеть английским языком настолько, чтобы ваша устная и письменная речь не шокировала носителей языка? В общем случае он только один: постоянная практика с адекватной обратной связью и систематические занятия в течение нескольких лет. Результаты могут быть блестящими, но ради них придется пройти путь утомительный и долгий.

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

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

Именно такое пособие в 2013 году выпустила ассоциация tekom, объединяющая европейских специалистов по технической коммуникации. Пособие адресовано, в первую очередь, авторам, которые разрабатывают технические документы на английском языке, не будучи его носителями.

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

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

Состав и содержание правил

Правила, приведенные в пособии, можно условно разделить на три группы:

  • правила оформления текста — оформление списков, заголовков и их смысловое содержание, оформление перекрёстных ссылок, глоссария;
  • правила построения предложений — построение простых для восприятия конструкций, стилистическое оформление текста, пунктуация, использование временных форм глаголов, порядок слов в предложении;
  • лексика — использование отглагольных форм, предлогов, аббревиатур, синтаксические особенности британского и американского вариантов английского языка, обозначение единиц измерения и т. д.

Чтобы дать более полное представление о содержании пособия, рассмотрим несколько правил, которые показались нам наиболее интересными и наименее очевидными для автора, который родился и вырос в русскоязычной среде.

Использование активного залога

В англоязычной технической документации следует по возможности использовать активный залог:

    An external server provides the software.
    The maintainance staff will replace the damaged tank.

вместо пассивного:

    The software is provided by an external server.
    The damaged tank will be replaced by the maintainance staff.

Использование союзов и союзных слов

Не следует опускать союзы и союзные слова. Авторы рекомендуют во всех случаях использовать союзы и союзные слова, даже если с точки зрения грамматики их допустимо не указывать.

Фраза:

    The letter sent to the US was delivered on time.

составлена вполне корректно. Однако авторы пособия предлагают использовать другой вариант:

    The letter that was sent to the US was delivered on time.

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

Фраза:

    If the red light stops blinking, then push the START button.

более предпочтительна, чем:

    If the red light stops blinking, push the START button.

пусть и звучит она, на превый взгляд, чересчур формально.

Использование наречий в пассивных конструкциях

При использовании пассивных конструкций рекомендуется располагать наречие непосредственно после первого вспомогательного глагола:

    The table will automatically be linked to the source file.

Несмотря на то, что фраза:

    The table will be automatically linked to the source file.

грамматически корректна (в данном случае наречие образа действия automatically может быть расположено либо после сказуемого, либо внутри него, между вспомогательным и главным глаголами), в технической документации так писать не принято.

Использование глаголов

В английском языке различают два стиля написания текста: так называемые nominal style — номинативный стиль, и verbal style —  глагольный стиль. Первый стиль близок к тому, что мы называем по-русски канцелярским стилем. Ему присуще обилие существительных, дополнений и союзов. Для глагольного стиля, напротив, характерно использование глаголов. Для русскоязычной документации «канцелярит» весьма типичен, поскольку считается, что текст, написанный таким стилем, выглядит более формальным. Исследования показывают, что в английском тексте, в том числе, в деловой и в технической документации, желательно использовать глагольный стиль, потому что он позволяет уменьшить длину предложений и облегчает понимание их смысла. Авторы пособия также рекомендуют использовать глагольный стиль (таблица 1).

Таблица 1

Отрицательный пример Положительный пример
To provide a clarification of his viewpoint is an important prerequisite. An important prerequisite is that he clarifies his viewpoit.
The cleaning of the kitchen took quite some time. It took quite some time to clean the kitchen.
Cleaning the kitchen took quite some time.

Использование придаточных предложений

Если придаточное предложение необходимо для понимания смысла всего предложения, то сам оборот запятыми не выделяют. Если же оно лишь дополняет смысл всего предложения и не является необходимым для понимания его сути, то оборот обосабляется запятыми. При этом в первом случае используется указательное местоимение that, а во втором which (таблица 2).

Таблица 2

Отрицательный пример Положительный пример
You may turn on the dialog, that is OFF by default, during start-up. You may turn on the dialog that is off by gefault during start-up.
You may turn on the dialog which is OFF by default during start-up. You may turn on the dialog, which is OFF by default, during start-up.

Подведем итоги

Теперь вернемся к примерам, приведенным в начале статьи, и еще раз сравним две фразы:

    Check the presence of Settings folder and create it if there is no such folder.

    Create Settnings folder or make sure that it already exists.

В построении второй фразы можно обнаружить следующие особенности, отвечающие приведенным в пособии рекомендациями:

  • предложение соответствует глагольному стилю написания: мысль: проверьте существование папки, выражена глагольным оборотом make sure that it already exists;
  • предложение основано на активном залоге;
  • граница придаточного предложения определена союзом that.

Можно заметить, что сформулированные в пособии правила формализуют те методы, которые позволяют избежать русскоязычной «кальки» в английском тексте.

Структура пособия

Несомненное достоинство пособия заключается в четкой структуре описания правил. Каждое из приведенных правил включает в себя следующие рубрики:

  • формулировку самого правила;
  • инструкции по применению правила;
  • положительные и отрицательные (в свете рассматриваемого правила) примеры;
  • указания по использованию правила;
  • замечания о возможности автоматической проверки соблюдения правила.

Помимо самих правил, в пособии даны рекомендации по внедрению на предприятии системы их соблюдения и проверки, рассматриваются вопросы анализа, планирования, внедрения и контроля исполнения данных правил.

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

Пособие содержит в общей сложности 116 правил, изложенных на 115 страницах. Оно пригодно к самостоятельному освоению , что позволяет рассматривать его как добротную методичку для технических писателей, инженеров по технической поддержке и других специалистов, в обязанности которых входит составление технических документов (и вообще технического текста) на английском языке.

Заключение

Благодаря формальному характеру многих правил (по нашим оценкам, таких примерно 70%) пособие станет хорошей основой для корпоративного или ведомственного руководства по стилю англоязычного технического текста. Существует возможность не только ручной, но и автоматизированной проверки соблюдения правил, сформулированных в пособии. Для этого можно использовать специализированные программные средства, в частности, системы управления контентом, поддерживающие функции управляемого языка (controlled language).

Пособие было разработано командой профессионалов в области технической коммуникации: профессоров, технических писателей и сотрудников таких компаний, как Bosch Automotive Service Solutions GmbH, Rohde & Schartz, Acrolinx GmbH и др.

Пособие можно приобрести на сайте ассоциации tekom.


Европейская ассоциация tekom — одно из наиболее крупных профессиональных объединений специалистов в области технической коммуникации. Ассоциация была образована в 2013 году отделением от своей предшественницы — немецкой национальной ассоциации tekom.

www.technical-communication.org

© «Философт», 2008–2017

+7 (499) 500-44-77

mail@philosoft.ru

SpyLOG