Коментування в огляді коду - це керування
Розглядайте коментарі як інструмент управління
Вставлення коментарів до огляду коду - це форма управління. Як такий, до нього слід підходити як до інструменту управління.
Використовуйте управлінські практики, коли коментуєте
Існує структура управління людьми, де метою є досягнення бажаного результату. Деякі основні підходи до управління не застосовуватимуться в коментарях, але більшість будуть. Застосовувані теми включають оточення, лідерство, організацію та контроль.
Середовище
Культура
Навколишнє середовище диктує стиль управління. Культуру та середовище робочого місця слід пам’ятати при використанні будь-яких інструментів управління. Зазвичай на це впливає галузь і розмір компанії чи суб'єкта господарювання.
Стиль
Якщо є безтурботна культура, то це може зустрітись у стилі управління, який використовується. Якщо є дуже суворі вказівки, політики та наслідки, то це повинно бути відображено у використаному стилі. Тож, якщо всі на борту зіркового вогню жартують, посилаючись на дроїдів та слабодушного штурмовика, то може бути застосований комедійний заклик. Однак, якщо є серйозні наслідки не сприйняття кінцевого результату всерйоз, то, можливо, його потрібно буде уникати.
Лідерство
Основи
Є три основні стовпи керівництва, які слід враховувати, коментуючи. А саме - це бачення, спілкування та судження.
Vision
Важливо, коли слід пам’ятати про велике бачення під час пояснення чи надання інструкцій. У коментарях це може означати вказівку на те, як невеликі зміни впливають на проект в цілому, які наслідки мають різні підходи, або підказку капелюха для роз'єднання проблем.
Communication
Бути хорошим комунікатором важливо у багатьох аспектах життя. У коментарях він не відрізняється. Застосування розумного рівня стислості важливо - тим більше, що коментарі не повинні займати багато місця. Достроково дістаньтесь до пункту, а потім при необхідності підкріпіть його прикладом. Для більшої організації це може також включати необхідність надсилати комюніке або повідомлення, якщо питання не локалізовано на одному сеансі огляду.
Judgement
Важливо, що стратегія використовується при оцінці того, чи потрібно робити коментарі чи ні, і які зміни повинні бути. Ваше судження не завжди повинно бути правильним, але воно повинно бути послідовно правильним, особливо коли проводяться великі виклики судів.
Організація
З точки зору менеджменту, організація стосуватиметься пам’яті про кінцеву мету та забезпечення того, щоб процеси узгоджувались відповідно до набору правил. Коментарі також повинні пам’ятати про це, оскільки коментарі, коли це можливо, спираються один на одного, щоб переконатися в дотриманні потоку дизайну. Також важливо мати на увазі сферу дії коду, який переглядається, щоб зменшити зв'язок та дотримуватися загальної конструкції.
Контроль
Контроль дій тих, хто ними керує, є делікатним процесом. Будучи твердим, слід пам’ятати, що люди важливі. Є кілька управлінських навичок, які використовуються під час контролю над іншими. Ці навички політичні, концептуальні, міжособистісні, діагностичні та технічні.
Політичні
Політику можна знайти, коли є взаємодія між людьми. Це величезна тема, але в загальному сенсі політика обертається навколо впливу. Важливо пам’ятати про особисту та професійну політику на роботі, роблячи коментар. Це може бути пов’язане з інструкцією, жартом чи навіть питанням.
Концептуальні
Управління за допомогою концептуалізації є важливим інструментом. Він вимагає комплексного аналізу ситуації, що знаходиться в цій ситуації. Коментуючи, може бути корисним включити деякий аналіз, який використовується для висновку чи зміни, зазначеного в огляді.
Міжособистісне
Міжособистісні навички дуже важливі при управлінні. Це теж велика тема. Однією з важливих речей, які слід враховувати при міжособистісних навичках, є наставництво, конструктивна критика та "гарпун".
Mentoring
Важливо, щоб менеджмент сприймався більше як наставник, ніж як антагоніст. У перегляді коду це означає, що іноді буде корисно включити кивок на схему дизайну чи підхід, які можна використати для поліпшення ситуації.
Constructive Criticism
Критика важлива, оскільки викликає рефлексію. Однак критику слід підтримувати максимально позитивно, коли вона може бути. Це означає запропонувати вагомі докази на підтвердження критики, а також гарантувати, що використаний тон не є негативним. При перегляді коду це може включати показ винятку або можливий сценарій, який би генерував помилку, маючи на увазі рішення, а не показував кожне місце, яке було неправильним, коли весь фрагмент коду потрібно було б замінити в будь-якому випадку.
"Harpooning"
"Гарпунінг" - це коли ти образно гарпуниш когось на землю. Це робиться, розбиваючи їх крок за кроком без будь-якого відшкодування до тих пір, поки вони не зможуть встати. Якщо ви переслідуєте людину в перегляді коду чи в іншому місці, ви втратите їх співпрацю. Важливо уникати надмірного злому.
Резюме
Розглядайте коментарі в огляді коду як інструмент управління. Майте на увазі, що коментарі повинні бути короткими, суттєвими та конструктивними. Також слідкуйте за тим, щоб коментувати особу, яку перевіряють, враховувати.