Техническая документация на английском языке

Техническая документация на английском языке

ykaneva 2018-04-09T16:54:33+00:00 September 13th, 2017 | Практика английского | 6 Comments 6 139,335

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

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

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

Содержание статьи «Английский для разработчиков»:

Ищем профессиональную лексику:

  1. Учебники
  2. Онлайн-ресурсы
  3. Наборы слов и технические английские словари
  4. Профессиональная литература (онлайн-журналы и блоги)

Качаем навыки:

  1. Аудирование (список видео и подкастов)
  2. Говорение (профессиональные соцсети для программистов)

Английский словарь для программистов: источники лексики

Лексика для разработчиков обширна. Те, кого обыватель может назвать «айтишником», включают в себя десяток разных специализаций: frontend разработчики, backend разработчики, тестировщики, веб-дизайнеры, продакты и другие (но все они должны уметь «чинить компьютер»).

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

1. Английский для it-специалистов: учебники

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

English for Information Technology – подходит для начального уровня. Включает в себя основную базовую лексику.

Career path Software Engineering – лексическое пособие для программистов, которое объединяет специализированную лексику и рабочие ситуации для развития навыков общения. Темы: разработка ПО, тестирование, пользовательский интерфейс, моделирование, варианты карьеры и др.

Oxford English for Information Technology – еще один полноценный курс. Подходит для среднего уровня. Включает в себя рабочую книгу студента и аудиокурс к ней.

Professional English in Use ICT – курс подходит для среднего уровня. Книга строится от простого к сложному, все юниты разбиты по темам.

Check Your English Vocabulary for Computers and IT – рабочая тетрадь, призванная улучшить понимание технической лексики. Включает в себя кроссворды, головоломки и др.

2. Английский для it: онлайн-курсы

В Интернете можно найти сайты и с различными онлайн-тренажерами для твоего технического английского.

lingualeo.com – начнем с себя. 🙂 У нас есть два «лакомства» для it-специалистов: курс «Английский для IT», который подходит даже для начального уровня, и онлайн-интенсив «Английский для IT бизнеса», который прокачивает и профессиональную лексику, и аудирование, и письменную и устную речь.

blairenglish.com – еще один классный сайт с онлайн-упражнениями. На нем ты найдешь тексты, в которых выделены новые слова, а ниже даны тесты на проверку этих новых слов.

www.english4it.com – сайт позиционирует себя, как интерактивная рабочая тетрадь в онлайн-режиме. На сайте есть тексты, аудио, словарь, задания и даже шутки.

3. Английский для ит-специалистов: словари

Найти базовые термины можно в специализированных наборах слов и словарях.

На Lingualeo есть наборы слов IT Terms, Startup Vocabulary, а также разговорники Business Meetings, Small Talk.

Специализированную лексику ты также сможешь найти на сайтах:

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

Читайте также:  Редактор для постов в инстаграме

4. Профессиональная литература: блоги, журналы для it-специалистов

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

Материалы на Lingualeo: технический английский для программистов

В библиотеке материалов Lingualeo более 250 тыс. аутентичных текстов, видео, аудио и т.д. Главная фишка в том, что ты можешь 1. нажать на незнакомое слово ⇒ 2. увидеть перевод ⇒ 3. добавить слово на изучение ⇒ 4. выучить его с помощью интерактивных тренировок. Да и контекст всегда будет с тобой.

У нас есть огромное количество материалов по IT-тематике: коллекция Coursera Information Tech & Design, коллекция CS Systems & Security, коллекция CS Software Engineering и др.

Также лексику и идеи можно черпать из коллекции TED Технологии и из специальной коллекции материалов Technology. А здесь мы собрали классные примеры Elevator pitch.

Как искать материалы: вводишь в поисковую строку любой технический термин по-английски и сортируешь материалы по уровню сложности и формату (видео, аудио, книга). Инструкция по ссылке.

Журналы и блоги на английском для разработчиков

Принцип работы с текстами на других сайтах может быть таким же удобным: 1. устанавливаешь наше бесплатное расширение ⇒ 2. тыкаешь на незнакомые слова ⇒ 3. и добавляешь их на изучение.

Где искать тексты:

Также изучи подборку: List of computer magazines

Работаем с другими навыками: аудирование, практика речи

Полноценное владение иностранным языком включает в себя 4 навыка: чтение (для него мы назвали много сайтов), аудирование, письмо и говорение (то есть речь). Для аудирования и речи найдем дополнительные ресурсы.

1. Аудирование: подкасты и видео

Часть коллекций на Lingualeo, о которых я говорила выше – Information Tech & Design, CS Software Engineering – это коллекции с видео, которые тоже помогут прокачать аудирование. Теперь давай найдем еще и подкасты:

  • Herding Code – технологические подкасты со Скоттом Алленом, Кевином Денте, Скоттом Куном и Джоном Галловэем.
  • Soft Engineering Radio – еще один классный сайт с подкастами для программистов.
  • iOSBytes – подкасты для iOS-разработчиков
  • Android Developers Backstage – подкасты для Android-разработчиков.
  • Talk Python To Me – подкасты для тех, кто работает с Python.

На самом деле можно найти и больше подкастов: погуглить «podcast + интересующий язык программирования, тема и др.».

Еще один лайфхак: начни смотреть какой-нибудь сериал про разработчиков в оригинале. Тебе поможет статья: Где смотреть сериалы на английском бесплатно.

2. Практика речи: профессиональные форумы

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

Таких форумов и социальных сетей огромное количество. Попробуй загуглить «social network for developers» и ты увидишь целую ленту подборок с описанием.

Подведем итоги: английский для веб-дизайнеров, it-специалистов

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

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

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

Так вот, можете ли вы привести примеры тех. документации для qa, web-design (особенно для этих двух сфер) и прочих специальностей, чтобы я смог получить представление об этом?

На запрос "тех документация qa" гугл выдает ссылки только на тест-кейсыб тест-планы и прочее.

Сегодня мы подвели итоги конкурса «Конёк документатора». Победители награждены призами, а лучшие работы мы опубликуем на нашем сайте.
Представляем вашему вниманию работу, занявшую 1 место: «Документация на английском языке (советы начинающим)». Автор – Софья Новикова, технический писатель в компании «Икстенс», г. Новосибирск. Пунктуация и орфография автора сохранены.

Так получилось, что весь мой опыт работы техническим писателем приобретался в компаниях, работающих с иностранными клиентами. Поэтому писать документацию мне приходилось преимущественно на английском языке. Хотелось бы поделиться опытом с теми техническими писателями, кто только начинает писать англоязычную документацию либо переводить русскоязычную документацию на английский язык. Конечно, хорошее знание английского языка – это первое и необходимое требование для достижения успеха, но недостаточное. Умение писать техническую документацию на русском языке так же может оказаться хорошим подспорьем, однако в англоязычной документации есть свои особенности, которые следует учитывать. Я расскажу об основных особенностях, которые мне удалось узнать за время своей работы.

Стандарты

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

Правильное написание элементов интерфейса

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

  1. «Check box» пишется раздельно, «Drop-down» – через дефис, а «ToolTip» – слитно
  2. «Click the button», но «Press the key»
  3. «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 — аудитория

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

Ссылка на основную публикацию
Тест эксель на собеседовании
Если вы хоть раз пытались устроиться на работу или же работаете на должности, в круг обязанностей которой входит принятие людей...
Тарифы мтс смарт 400 руб
С того момента как тариф «Смарт» стал доступен для активации, он претерпел множество изменений. Они касаются размера абонентской платы, количества...
Тарифы ростелекома на домашний интернет
Полный список актуальных тарифов Ростелеком для города Москва. Подключай тарифы Rostelecom в Москве бесплатно и пользуйся качественными услугами интернета и...
Тестирование cd и dvd дисков
В этой статье я опишу программу тест Nero CD DVD Speed, которая разработана компанией "Nero Softwsre AG". С помощью программы...
Adblock detector