ewidencjaipbox.pl

Dowody pracy w ewidencji: co musi znaleźć czytelnik

Ewidencję czyta ktoś, kogo przy pracy nie było: doradca, kontroler, Ty sam za rok. Dowód ma mu pozwolić odpowiedzieć na jedno pytanie: kto, co i kiedy zrobił przy tym prawie.

Czytelnik ewidencji nie był przy tej pracy

Wpis, który dla autora jest oczywisty („poprawki w module”), dla czytelnika nic nie znaczy. Pisząc dowód, pomyśl o osobie, która za rok otworzy ewidencję bez kontekstu, nie zna projektu i ma dwadzieścia minut.

Takiej osobie wystarczą cztery rzeczy: data, wykonawca, opis w jednym zdaniu i odnośnik do źródła. Z tych elementów da się zbudować obraz roku bez dodatkowych wyjaśnień.

Co zwykle liczy się jako dowód pracy nad programem

Naturalnym śladem pracy programisty są jego zwykłe narzędzia. Nie trzeba tworzyć osobnej dokumentacji dla ulgi, wystarczy wskazać to, co już istnieje.

  • commity i pull requesty z czytelnym opisem zmiany,
  • zgłoszenia i zadania z trackera, z datami rozpoczęcia i zamknięcia,
  • notatki projektowe i decyzje architektoniczne,
  • wydania z listą zmian,
  • dokumentacja techniczna powstająca razem z kodem.

Jak powiązać dowód z konkretnym prawem

Dowód zapisany „w ogóle” nie pomoże, gdy ulgą objęto dwa różne programy. Każdy wpis wiąż z jednym prawem i, jeśli się da, z tą samą nazwą, której używasz w spisie praw. Praca dotycząca wspólnej biblioteki wymaga krótkiej notatki, jak ją podzielono między prawa.

Dobrze jest też dopisać, czy zadanie dotyczyło tworzenia nowej funkcji, rozwijania istniejącej, czy zwykłej naprawy. Ta rozmowa zwykle i tak wraca u doradcy, więc lepiej mieć odpowiedź zapisaną od razu.

Jak wygląda słaby dowód

Najsłabszy jest zrzut ekranu bez daty, bez autora i bez wskazania, czego dotyczy. Niewiele lepszy jest commit „fix” albo „zmiany” oraz plik zapisany pod nazwą „final_v3”. Takie ślady istnieją, ale nikt nie potrafi ich zinterpretować.

Słabe są także dowody dopisane hurtem na koniec roku. Jeśli data wpisu jest późniejsza niż data pracy, zapisz obie, żeby było widać, że to rekonstrukcja. Uczciwie oznaczony wpis jest wiarygodniejszy niż udawana bieżąca notatka.

Prywatne repozytorium i załączniki

Jeśli repozytorium jest prywatne, nie musisz go nikomu udostępniać w całości. Wystarczy zapisać identyfikator commita lub zgłoszenia i w razie potrzeby pokazać zrzut z widocznym autorem i datą.

Ten sam układ można prowadzić w arkuszu albo w Faden IP Box, gdzie wpis ma tytuł, datę, opis, odwołania i załączniki przy konkretnym prawie. Zanim ewidencja zacznie obrastać pomyłkami, sprawdź listę typowych błędów.