Где встречается: код, доки, тикеты, созвоны
Тема дорожной карты · Английский для IT
🔊 Словарь терминов с произношением →
Английский в работе инженера появляется в пяти слоях, и у каждого свои требования к языку. Первый слой — сам код: ключевые слова языков, имена функций и переменных, комментарии, сообщения об ошибках компилятора и рантайма. Второй — документация и справочники: официальные доки, man pages, README, changelog, RFC. Третий — коммуникация вокруг кода: commit messages, pull request, code review, GitHub Issues. Четвёртый — процессные артефакты: тикеты в Jira, user stories, спецификации, ADR, постмортемы. Пятый — живое общение: стендапы, созвоны, демо, собеседования. Первые два слоя требуют чтения, третий и четвёртый — письма, пятый — речи и понимания на слух. Именно в таком порядке большинство инженеров и осваивают язык.
Как произносится
Слова этой темы, которые часто произносят неверно: documentation /ˌdɒkjʊmɛnˈteɪʃən/ (ударение на «тей»), comment /ˈkɒmɛnt/ (ударение на первый слог, а не «коммЕнт»), issue /ˈɪʃuː/ («ишью», не «иссью»), ticket /ˈtɪkɪt/, repository /rɪˈpɒzɪtəri/ (ударение на «по», четыре слога, а не «репозитОри»), changelog /ˈtʃeɪndʒlɒɡ/, standup /ˈstændʌp/, call /kɔːl/. Слово meeting /ˈmiːtɪŋ/ носители используют чаще, чем call, когда речь о запланированной встрече.
Как употребляется
Каждому слою соответствует свой типовой английский:
- Код:
// TODO: handle timeout,raise ValueError("expected a list"),Cannot read properties of undefined. - Документация: Prerequisites, Usage, Configuration, Troubleshooting, See also.
- Вокруг кода: fix(api): return 404 for unknown ids, LGTM, Could you add a test for the empty case?
- Процесс: As a user, I want to reset my password so that I can regain access, Acceptance criteria, Definition of done.
- Речь: Yesterday I finished the migration, today I'm on the flaky test, no blockers.
Полезно замечать, что один и тот же смысл в разных слоях звучит по-разному: в коде deprecated, в changelog This option is deprecated and will be removed in 3.0, на созвоне we're phasing that out.
Ловушки
Первая ловушка — учить только первый слой. Инженер, который свободно читает код, но не может написать понятное описание PR, выглядит для международной команды слабее, чем он есть. Вторая ловушка — переносить язык одного слоя в другой: сокращения из чата (pls, u, thx) в тикете и в документации выглядят небрежно, а канцелярские конструкции из спецификации (It is hereby required that) в стендапе звучат комично. Третья — думать, что созвоны это про словарь. На созвонах проблема почти всегда в скорости и акцентах, а не в незнакомых словах, и лечится это только практикой прослушивания.