Komentowanie w przeglądzie kodu jest zarządzanie
Traktuj komentarze jako narzędzie zarządzania
Wstawianie komentarzy do recenzji kodu jest formą zarządzania. Jako takie należy traktować je jako narzędzie zarządzania.
Komentując, stosuj praktyki zarządcze
Istnieje struktura zarządzania ludźmi, w której celem jest osiągnięcie pożądanego rezultatu. Niektóre z głównych podejść do zarządzania nie będą miały zastosowania w komentarzach, ale większość tak. Odpowiednie tematy obejmują środowisko, przywództwo, organizowanie i kontrolowanie.
Środowisko
Kultura
Środowisko dyktuje styl zarządzania. Korzystając z jakichkolwiek narzędzi zarządzania, należy pamiętać o kulturze i środowisku pracy. Zwykle wpływa na to przemysł i wielkość zarządzanej firmy lub podmiotu.
Styl
Jeśli istnieje kultura o lekkim sercu, może to wynikać ze stosowanego stylu zarządzania. Jeśli istnieją bardzo surowe wytyczne, zasady i konsekwencje, należy to odzwierciedlić w zastosowanym stylu. Więc jeśli wszyscy są na pokładzie, aby żartować o gwiezdnych wojnach odnoszących się do droidów i słabo nastawionego szturmowca, może mieć zastosowanie komediowa interwencja. Jeśli jednak istnieją poważne konsekwencje nietraktowania wyniku końcowego poważnie, może być konieczne jego uniknięcie.
Przywództwo
Podstawy
Komentując, należy wziąć pod uwagę trzy główne filary przywództwa. Mianowicie są one wizją, komunikacją i osądem.
Vision
Ważne jest, aby pamiętać o wielkiej wizji podczas wyjaśniania lub udzielania instrukcji. W komentarzach może to oznaczać wskazanie, jak niewielkie zmiany wpływają na projekt jako całość, jakie są implikacje przyjęcia różnych podejść lub wskazówka dotycząca oddzielenia problemów.
Communication
Bycie dobrym komunikatorem jest ważne w wielu aspektach życia. Nie inaczej jest w komentarzach. Ważne jest stosowanie rozsądnego poziomu zwięzłości - zwłaszcza, że komentarze nie powinny zajmować dużo miejsca. Przejdź do rzeczy wcześnie, a następnie w razie potrzeby wykonaj kopię zapasową przykładu. W większej organizacji może to również obejmować konieczność wysłania komunikatu lub notatki, jeśli problem nie zostanie zlokalizowany na jednej sesji recenzji.
Judgement
Ważne jest, aby strategia była używana przy ocenie, czy należy wprowadzić komentarze, i jakie zmiany należy wprowadzić. Twój osąd nie zawsze musi być poprawny, ale musi być konsekwentnie poprawny, szczególnie w przypadku dokonywania dużych osądów.
Organizowanie
Z punktu widzenia zarządzania organizacja będzie polegała na pamiętaniu o celu końcowym i zapewnieniu, że procesy są dostosowane do zestawu reguł. Komentarze powinny również mieć to na uwadze, ponieważ w miarę możliwości komentarze powinny się wzajemnie opierać, aby mieć pewność, że przebieg projektu jest przestrzegany. Ważne będzie również, aby pamiętać o zakresie poddawanego przeglądowi kodu, aby zmniejszyć sprzężenie i postępować zgodnie z ogólnym projektem.
Kontrolowanie
Kontrolowanie działań zarządzanych osób to delikatny proces. Będąc stanowczym, należy również pamiętać, że ludzie są ważni. Istnieje kilka umiejętności kierowniczych do wykorzystania podczas kontrolowania innych. Te umiejętności są polityczne, koncepcyjne, interpersonalne, diagnostyczne i techniczne.
Polityczny
Politykę można znaleźć za każdym razem, gdy dochodzi do interakcji między ludźmi. To ogromny temat, ale ogólnie rzecz biorąc, polityka obraca się wokół wpływów. Podczas komentowania ważne jest, aby pamiętać o polityce osobistej i zawodowej w pracy. Może to być związane z instrukcją, żartem, a nawet pytaniem.
Konceptualistyczny
Zarządzanie poprzez konceptualizację jest ważnym narzędziem. Wymaga kompleksowej analizy aktualnej sytuacji. Komentując, może być korzystne uwzględnienie niektórych analiz wykorzystanych do sformułowania wniosków lub zmian wskazanych w przeglądzie.
Interpersonalne
Umiejętności interpersonalne są bardzo ważne podczas zarządzania. To także duży temat. Niektóre ważne rzeczy, które należy wziąć pod uwagę przy umiejętnościach interpersonalnych, to mentoring, konstruktywna krytyka i „harpooning”.
Mentoring
Ważne jest, aby zarządzanie było postrzegane bardziej jako mentor niż jako antagonista. W przeglądzie kodu oznacza to, że czasami korzystne będzie włączenie ukłonu do wzorca projektowego lub podejścia, które można zastosować do poprawy sytuacji.
Constructive Criticism
Krytyka jest ważna, ponieważ wywołuje refleksję. Jednak krytyka powinna być możliwie jak najbardziej pozytywna. Oznacza to przedstawienie wiarygodnych dowodów na poparcie krytyki, a także upewnienie się, że użyty ton nie jest negatywny. Podczas przeglądania kodu może to obejmować pokazanie wyjątku lub możliwego scenariusza, który wygenerowałby błąd, sugerując rozwiązanie, zamiast pokazywania każdego miejsca, które było niepoprawne, gdy cały fragment kodu i tak musiałby zostać wymieniony.
"Harpooning"
„Harpooning” ma miejsce, gdy w przenośni harpuje się kogoś na ziemię. Odbywa się to poprzez dzielenie ich krok po kroku, bez żadnej ulgi, aż do momentu, w którym nie będą mogli wstać. Jeśli harpunujesz osobę podczas przeglądu kodu lub w innym miejscu, stracisz współpracę. Ważne jest, aby unikać nadmiernego niszczenia kogoś.
Streszczenie
Traktuj komentarze w przeglądzie kodu jako narzędzie zarządzania. Pamiętaj, że komentarze powinny być krótkie, rzeczowe i konstruktywne. Upewnij się także, że podczas komentowania brana jest pod uwagę osoba recenzowana.