Knowledge Transfer English: Phrases for Handoffs and Documentation

Introduction

Передача знань — це процес передачі інформації, контексту та досвіду від однієї людини або команди до іншої. Це відбувається, коли інженери залишають команду, коли відповідальність змінюється під час реорганізації, коли приєднуються нові члени, або коли змінюється ротація на виїзді. Ефективна передача знань вимагає як хороших практик документації, так і чіткого спілкування англійською мовою. Цей посібник містить словниковий запас і фрази, які досвідчені інженери використовують під час планування, виконання і обговорення передачі знань.

Основні наукові праці: «Психологія та психологія знань»

Дві концепції визначають, чому важлива передача знань:

Знання племен — це інформація, яка існує лише у головах людей — ніде не записана. « Ми маємо багато знань племен щодо цієї старої служби » означає, що система погано задокументована і лише деякі люди знають, як вона працює. Це завжди ризик. Інженери кажуть: «Ми повинні витягнути це з голови людей і ввести у вікі»

** Коефіцієнт шини ** (іноді називається ** коефіцієнт лотереї **) — це мінімальна кількість членів команди, які, якщо їх раптово не буде, можуть поставити під загрозу проект. « Наш коефіцієнт шини для модуля платежу дорівнює 1 — тільки Марія знає, як це працює. » Коефіцієнт шини 1 є небезпечним. Інженери кажуть: « Нам потрібно збільшити коефіцієнт шини на цьому компоненті ». Метою є завжди мати коефіцієнт шини принаймні 2 або 3.

Документи та підручники Handoff

Основними артефактами передачі знань є документи:

• ** документ передачі** (також називається ** записом про передачу**) — структурований документ, який хтось, хто залишає роль або команду, пише для свого наступника; « Я пишу документ передачі для своєї заміни »
• ** runbook ** — документ, у якому описано, як виконувати повторювані операційні завдання або як реагувати на інцидент; « runbook для перезапуску служби API знаходиться у Confluence »
• ** playbook ** — схожий на runbook, але часто більш стратегічний; описує, як реагувати на категорії ситуацій; « наш інцидент playbook визначає процедури реагування для різних рівнів тяжкості »
• ** onboarding guide ** — документ для нових членів команди, у якому пояснюється, як розпочати роботу; « ми підтримуємо посібник з впровадження, щоб нові інженери могли бути продуктивними у перший тиждень роботи »
• ** архітектурний запис рішення (ADR) ** — документ, що записує, чому було прийнято технічне рішення; “ADR пояснює, чому ми обрали Kafka над RabbitMQ в 2019 році”

Інженери часто кажуть: «Ми повинні документувати «чому», а не тільки «що». » ADR захоплює обґрунтування, обмеження і розглянуті альтернативи — контекст, який інакше був би втрачений, коли оригінальні приймачі рішень покинули.

Інформаційні передачі

Іноді документацію доповнюють особисті (або відео) сеанси:

• ** сяйво ** — стежити за досвідченим інженером під час його роботи, вчитися за допомогою спостереження; « Я стежив за інженером- дежурним протягом двох тижнів перед тим, як почати роботу »
• ** парний сеанс програмування ** — спільна робота над кодом; цінний для передачі знань, оскільки досвідчений інженер пояснює рішення, які вони приймають
• ** deep dive ** — фокусована зустріч або сеанс, під час якого буде докладно досліджено певну систему або тему; « ми запланували глибоке занурення у службу розпізнавання перед передачею »
• ** walkthrough ** — крок за кроком веде когось через систему, процес або базу коду; « дозвольте мені провести з вами огляд потоку розгортання »
• ** передавальну зустріч ** — офіційна зустріч, під час якої знання явно передаються від однієї людини до іншої; « ми мали 3- годинну передавальну зустріч перед моїм останнім днем »

Оцінка повноти

Під час завершення передачі знань інженери використовують фрази для перевірки охоплювання:

• «Чи є якісь прогалини в документації?» — запитання, чи було щось важливе пропусчене
• «Чи є щось, що вам потрібно викопати з пам’яті, перш ніж ви поїдете?» — запитуючи від’їжджаючих інженерів про племінні знання
• «Чи відчуваєте ви впевненість у тому, що це приймаєте?» — перевірка того, що отримувач має достатньо контексту
• «Які питання у вас ще є?» — запрошуючи отримувача вивести на поверхню залишкові невизначеності
• “Ми зробимо ретро на передачі через 30 днів” - запланувати подальші дії, щоб визначити, що відсутнє

Ключовий словник

Term	Definition
tribal knowledge	Information known only to certain individuals, not written down
bus factor	Minimum number of people whose absence would cause project failure
handoff document	A structured document written for a successor when leaving a role
runbook	Step-by-step operational instructions for a recurring task or incident response
ADR	Architecture Decision Record — documents why a technical decision was made
shadowing	Learning by observing an experienced colleague as they work
deep dive	A focused session for detailed exploration of a system or topic
walkthrough	Guiding someone through a system or process step by step
onboarding guide	Documentation to help new team members get started quickly
handover meeting	A formal meeting for transferring responsibilities and context

Практичні поради

1. ** Написання підручника з виконання для завдання, яке ви виконуєте регулярно. ** Почніть з найпоширенішого завдання — перезапуску служби, розгортання випуску або зміни секрету — і напишіть покрокові інструкції. Практикуюсь, чтобы это было достаточно ясно, чтобы кто-то незнакомый с системой мог следить за ней в 2 часа ночи во время инцидента.

2. ** Вправляйтеся у використанні фрази « дайте мені витягнути це з голови і записати у документ ». ** Цей спосіб є знаком хорошої культури документації і професійним способом сказати, що ви збираєтеся записати щось, перш ніж поділитися ним усно.

3. ** Використовуйте « фактор шини » в обговореннях архітектури. ** Коли проектування системи сильно залежить від досвіду однієї людини, скажіть: « У нас є проблема фактора шини — ми повинні це задокументувати і підібрати другого інженера для цього компонента. »

4. ** Навчіться писати хороші заголовки рішень про АДР. ** Заголовок рішень про АДР повинен описувати рішення, а не тему. Не « Стратегія кешування », а « Ми обирали Redis замість Memcached для кешування сеансів ». Практикуйте перетворення тем у вирази для прийняття рішень.

Conclusion

Словник передачі знань — племінні знання, фактор шини, документ передачі, підручник, ADR, тенетне відображення — описує набір практик, на які покладається кожна професійна інженерна команда. Освоєння цих термінів допоможе вам розпізнати ризики, пов’ язані з використанням знань у вашій команді, підтримувати культуру документації і професійно виконувати передачі, коли змінюються ролі і обов’ язки. Хороша передача знань, в кінцевому підсумку, стосується поваги до ваших колег і до людей, які прийдуть після вас.

Розвиток наукових знань: впровадження наукових знань у практичну діяльність

Погляньмо правді в очі – «племінні знання» існують в кожній організації. Це той недокументований процес, особливий спосіб робити речі, відомий лише декільком ключовим особам. Хоча це цінно спочатку, покладаючись тільки на це, можна створити вразливості, коли ці люди залишаться або стануть недоступними. Метою чітких передачі і документації є не тільки ефективність; це, в основному, зменшення ризику - особливо щодо страшного “фактору шини”. Фрази на кшталт “перехід власності” є тут вирішальними, рухаючись далі простого затвердження завдання, яке потрібно зробити, і активно описуючи * хто * відповідальний за його підтримку. Нам потрібно сформулювати не тільки * що * було побудовано, але також * чому * це було побудовано таким чином, включаючи будь-які основні припущення або залежності. Цей проактивний підхід мінімізує перешкоди, коли хтось відходить і забезпечує безперервність операцій. Крім того, такі фрази як «як є» проти «бути» є критичним у документуванні змін - чітко зазначаючи поточний стан, а потім описуючи запропонований новий стан зменшує неоднозначність під час процесу передачі. Розгляньте ситуації, коли здавалося б незначна зміна вводить несподівані проблеми пізніше; ретельна документація надає контекст, необхідний для швидкого діагностування і вирішення цих проблем. Нарешті, при обговоренні складних систем або процесів з нетехнічними зацікавленими сторонами, пам’ятайте, що чітке спілкування є найважливішим. Уникайте жаргону і технічних термінів, де це можливо, вибираючи прості пояснення, які зосереджені на впливі системи або процесу - як це приносить користь бізнесу. Це сприяє розумінню і співпраці, необхідних інгредієнтів для успішного передачі знань.

Поширений сценарій включає в себе впровадження нових розробників в архітектуру мікросервісів. Спочатку команда сильно покладається на недокументовані процедури для розгортання оновлень до authentication-service. Сама документація фрагментована, знаходиться в застарілих вікі і розкиданих гілках Slack. Під час недавнього інциденту - викликаного випадковим розгортанням пошкодженої версії - головний інженер використовував інструмент командного рядка, щоб швидко повернути пошкоджений код (найкраща практика, яку вони підтримували, але не повністю задокументували). Негайне спілкування було спрямоване на мінімізацію часу простою, а потім на структуроване розслідування того, чому відбулося помилкове розгортання. Це призвело до обговорення щодо поліпшення CI / CD конвеєра і встановлення більш надійних процедур тестування - все підкріплене чіткою документацією, яка описує новий робочий процес і відповідальність.

# Example CLI command for rolling back a microservice deployment (hypothetical)
./rollback-deployment --service authentication-service --version 1.2.3

Команда rollback-deployment, хоча і проста в цьому прикладі, представляє документований процес - той, що зараз є частиною стандартної операційної процедури. Цей перехід від покладання на індивідуальну експертизу до кодифікованих процесів значно зменшив вразливість команди і поліпшив їх здатність ефективно реагувати під час критичних ситуацій. В кінцевому підсумку, ефективна передача знань не просто про передачу інформації; це про вбудоване розуміння і підзвітність в організації.