Англійські статті (A, An, The) для технічного письма
Вивчіть практичні правила правильного використання a, an і the у технічній документації і коментарях до коду, призначені для розробників, рідна мова яких не має статей.
Для розробників, чия рідна мова не використовує артиклі — слов’янські мови, багато азійських мов — « a », « an » і « the » є найскладнішими частинами англійської граматики для впровадження, оскільки рідко є переклад один- на- один, на який можна покластися. Хороші новини в тому, що технічне письмо слідує більш передбачуваним шаблонам, ніж повсякденна мова, тому декілька правил покривають більшість того, що ви будете писати.
Ключовий словник
** « The » для чогось вже відомого або конкретного ** — скористайтеся « the », якщо і автор, і читач можуть точно визначити, що ви маєте на увазі, або тому, що це було вже згадано раніше, або тому, що існує лише одна така річ.
- “Ми розгорнули нову службу автентифікації минулого тижня. Служба обробляє всі запити на входи.” (Друга згадка — “the” посилається на конкретну службу, що тільки що була введена.)*
** « A/ an » для введення чогось нового або унікального ** — скористайтеся « a » або « an », коли ви вперше згадуєте щось, або коли ви маєте на увазі « будь- який » елемент категорії, а не певний екземпляр.
- « Ми вводимо новий шар кешування ». (Перша згадка — читач ще не знає, який шар кешування.) *
** Немає артиклю для множини і незліченних іменників у загальних висловлюваннях** — коли йдеться про категорію (а не про конкретний випадок), множини іменників і незліченних іменників часто не мають артиклю.
- « Мікросервіси спілкуються за допомогою мережі ». (Загальна інформація про мікросервіси як категорію — перед « мікросервіси » не потрібна стаття.) *
- « Затримка збільшилася після розгортання ». (Незліченне іменник « затримка » — без артикля.) *
** « The » для чогось унікального або вже визначеного контекстом ** — використовуйте « the » для речей, які є унікальними у контексті, наприклад, « the database », коли у розмові є лише одна відповідна база даних, навіть при першій згадці.
- « Перевірити журнали перед перезапуском служби ». (У цьому контексті поняття « журнали » і « служба » розглядаються як специфічні, навіть якщо їх не згадано раніше.) *
Звичайні фрази
- «Ми додали нову кінцеву точку до API.» (new = «a», existing/specific = «the»)
- «Багато хто з них був задіяний у гонках на льоду»
- «Помилки збільшилися після розгортання.» (загальна множина, без артикля; конкретне розгортання, «the»)
- «Це поширений шаблон в розподілених системах.» (один приклад категорії = «a»)
- Команда вирішила відкласти реліз
Приклади висловлювань
Перша згадка проти другої згадки в одному абзаці:
- “Ми створили обмеження швидкості для захисту API від зловживання. Обмежувач швидкості використовує алгоритм рухомого вікна і відкидає запити, як тільки обмеження перевищується.”*
Загальний вираз без артиклю, за яким слідує певний випадок з « the »:
- “Кешування покращує швидкодію за рахунок зменшення навантаження бази даних. Кеш, який ми використовуємо для цієї служби, це Redis, налаштований з п’ятихвилинним TTL.”*
Вибір « a » проти « an » за звуком, а не за буквою:
- « Це запит HTTP. » (починається з голосного звуку, « ітч- ті- ті- пі») *
- « Це скорочення адреси URL. » (« URL » починається з приголосного звуку, « ти- ти- вона ») *
Опускання артиклю для технічних іменників, які не можна злічити: “Пропускна здатність значно впала після міграції, хоча затримка залишилася приблизно такою ж.”
Професійні поради
- Запитайте себе: « Чи читач вже знає, про яку я маю на увазі? » Якщо так, скористайтеся ** « the ». ** Якщо ви згадуєте її вперше, або якщо ви маєте на увазі « будь- яку », скористайтеся ** « a/ an ». **
- Для незліченних іменників, що зустрічаються в технічному письмі — затримка, пропускна здатність, пам’ять, пропускна здатність, документація — зазвичай не потрібна стаття в загальних висновках.
- ** A проти an** залежить від звуку, а не від правопису: « запит HTTP » (звук голосного), але « адреса URL » (звук приголосний, « ви »).
- Якщо іменник є ** унікальним у спільному контексті ** розмови — « база даних », « конвеєр розгортання » — ви можете використовувати « the » навіть при першій згадці, якщо обидві сторони вже знають, який з них має на увазі.
- Якщо ви не впевнені, прочитайте речення вголос — носії рідної мови часто «чують» правильний артикль, навіть коли вони не можуть вказати правило; цей інстинкт розвивається з практикою читання.
Практичні вправи
- Напишіть два речення про ваду: першу згадку з « a », другу згадку з « the. »
- Напишіть загальне твердження про бази даних без статті, а потім конкретне твердження про « базу даних » у вашому власному проекті.
- Виберіть « a » або « an » правильно для: API, URL, кінцевої точки HTTP, запиту SQL.
Розвиток інформаційних технологій: проблеми та перспективи в інформаційній економіці
Зрозуміти роль the проти a/an’s не тільки стосується граматики; це важливий елемент чіткого спілкування в команді розробників. Для не-рідних носіїв, особливо тих, хто переходить до професійної англійської, ці здавалося б прості слова можуть бути на диво складними для опанування, часто призводячи до плутанини в перегляді коду, повідомленнях Slack і документації проекту. Основна проблема виникає з концепції визначеності - вказуючи, чи ви маєте на увазі щось конкретне або загальне. У багатьох мовах це розрізнення не жорстко впроваджено, тому переклад безпосередньо на англійську мову може ввести значну неоднозначність. Це більше, ніж просто вибір правильного слова; це про передачу точності і намірів, що є життєво важливим для співпраці в швидкому технічному середовищі.
Розглянемо такий сценарій: ви надіслали запит на звантаження з таким описом: « Виправлено помилку у розпізнаванні користувача ». Людина, для якої мова є рідною, скоріш за все, використає « the » — « Виправлено помилку у розпізнаванні * the * користувача ». Проте, для когось, хто навчається чітко сформулювати технічні питання, це може звучати неприродно і, можливо, призвести до плутанини. Чи це певна вада, яку вже було виявлено? Чи це просто поширена проблема з автентифікацією користувача загалом? Вибір впливає на те, як рецензенти підійдуть до проблеми. Аналогічно, під час перегляду коду, коментар на зразок « Це виправляє виняток нульового вказівника » можна зміцнити додаванням * the *, якщо він стосується відомої проблеми: « Це виправляє * the * виняток нульового вказівника, про який раніше було повідомлено ». Без цього пояснення стаття ризикує звучати нечітко і, можливо, неповну.
Крім того, точність у документації є найважливішою. Під час опису API або системних компонентів, послідовне використання статей сприяє яснішому розумінню для всіх членів команди, незалежно від їх рідної мови. Підтримка послідовності уникає неправильних інтерпретацій, які можуть призвести до помилок або переробки. Це про встановлення спільного словника - спільної основи для ефективного співробітництва. Пам’ятайте, технічне письмо не просто про передачу інформації; це про те, щоб всі були на одній сторінці.
Проілюструємо це на простому прикладі з використанням curl :
curl -s "https://api.example.com/users?id=123"
Тут ми конкретно запитуємо дані для * користувача *, який визначено за ID 123. Послідовне використання « the » зберігає ясність і уникнення двозначності у самій команді і будь- якій супутній документації, що описує її призначення. Ця дрібниця може значно вплинути на потоки комунікації в процесі розробки вашої команди.