Ten przewodnik ma na celu pomóc organizacjom w zrozumieniu, jakie problemy można rozwiązać dzięki lepszej dokumentacji, a także jak wybrać odpowiednie wskaźniki na potrzeby projektów związanych z dokumentacją.
Obecny etap:
opracowywanie dokumentacji. Sprawdź oś czasu.
Opisz problem
Zanim zaczniesz wybierać dane, upewnij się, że dobrze rozumiesz problem, który próbujesz rozwiązać. Podaj jak najwięcej szczegółów.
- „Pobieranie próśb o udostępnienie dokumentacji wprowadzającej trwa zbyt długo. Współtwórcy poddają się i odchodzą”.
- „Zauważyliśmy zbyt wiele zgłoszeń, aby uzyskać pomoc w zrozumieniu kodów błędów”.
- „Nasz potok CI/CD nie działa. Zbyt wiele testów kończy się niepowodzeniem z powodów niezrozumiałych”.
- „Na naszych cotygodniowych spotkaniach ludzie wydają się zdenerwowani”.
Opracuj hipotezę
Szukaj przyczyn i skutków. Co może być przyczyną podanego problemu? Pamiętaj, że problemy mogą mieć wiele przyczyn lub się pokrywać.
- „Scalanie żądań pull dotyczących dokumentacji wprowadzającej trwa bardzo długo, ponieważ nie mamy jasnych wytycznych dotyczących stylu. Weryfikatorzy odkładają sprawdzanie PR, ponieważ nie wiedzą, co robić, lub często wymieniają się informacjami z osobami związanymi z formatowaniem”.
- „Użytkownicy muszą rozwiązać problemy, ponieważ nie mogą znaleźć w dokumentacji informacji o kodach błędów”.
- „Nasze testy CI/CD kończą się niepowodzeniem, ponieważ nasz dostawca ma ograniczenia i limity czasu oczekiwania”.
- „Na naszych cotygodniowych spotkaniach ludzie mają zmęczenie, ponieważ mają się one o 5:30 w swojej strefie czasowej”.
Zaproponuj rozwiązanie
Czy ten problem można rozwiązać, używając nowej lub lepszej dokumentacji?
- „Gdybyśmy mieli wskazówkę dotyczącą stylu, weryfikatorzy mogliby ją sprawdzić przed przesłaniem swoich informacji PR. Weryfikatorzy wiedzą, co sprawdzić. Weryfikatorzy i współtwórcy nie będą musieli się kłócić o format, ton i styl”.
- „Gdybyśmy mieli dokumentację na temat kodu błędu, użytkownicy mogliby znaleźć w niej odpowiedzi, zamiast otwierać problemy”.
- „Wygląda na to, że lepsza dokumentacja nie rozwiąże naszego problemu CI/CD”.
- „Każde spotkanie zaczynamy od żartu „puk, puk”. Stworzenie kolekcji dowcipów o pukaniu, pomoże nam zacząć spotkania z uśmiechem”.
Skoncentruj się
Czy potrafisz zmierzyć problem?
- „Co naprawdę oznacza «scalanie PR-ów trwa zbyt długo?” Dwa miesiące? Dwa tygodnie? Jak długo współtwórcy będą czekać na sprawdzenie, zanim zrezygnują?”
- „Ile problemów z kodem błędu oznacza „zbyt wiele problemów”?
- „Hmmm... jaki jest „zbyt zrzędliwy”?
Sprawdź mierzalność
Jak można sprawdzić proponowane dane? Czy można je łatwo i dokładnie mierzyć? Czy pomiar zależy od tego, kto go przeprowadza?
- „Możemy z łatwością sprawdzić, jak długo prośba o weryfikację jest otwarta, a także jak długo od niej została przesłana. Nie jesteśmy w stanie dokładnie określić, kiedy dana osoba rezygnuje”.
- „Możemy policzyć, ile problemów zostało oznaczonych tagiem „error-code” (kod błędu) lub wyszukać w problemach tekst kodu błędu.
- „Nie możemy dokładnie zmierzyć zrzędy ludzkości w sposób taktyczny ani dokładny”.
Dodaj dodatkowe dane
Czy są inne wskaźniki, które pomogłyby ustalić, czy Twoja dokumentacja rozwiązuje problem? Czy docelowy wskaźnik jest taki sam w każdym przypadku?
- „Sprawdzanie dłuższego PR wymaga więcej czasu. Dla różnych poziomów PR należy ustawić różne progi. Chcemy mierzyć czas scalenia w przypadku małych, średnich, dużych i ogromnych podmiotów”.
- „Możemy sprawdzić, ile wizyt otrzymuje nasz kod błędu i czy liczba ta odpowiada mniejszej liczbie otwieranych problemów”.
Wybierz przedział czasu
- „Uważamy, że 2 tygodnie to wystarczający czas na scalenie małych i średnich kontaktów PR. Wszystkie PR powinny zostać połączone w ciągu miesiąca. Będziemy więc dokonywać pomiarów co 2 tygodnie”.
- „Nie ma sensu codziennie aktualizować liczby problemów związanych z kodem błędu, ponieważ zwykle zamykamy problem w ciągu tygodnia. Będziemy je mierzyć co tydzień”.
Zapisz cele
Jaką zmianę trzeba byłoby zobaczyć w wybranym wskaźniku, aby można było stwierdzić, że projekt odniósł sukces? Rozważ wyznaczenie celów ilościowych dla wybranych danych.
- „Jeśli uda nam się osiągnąć cel, jakim jest zamknięcie wszystkich nowych działów PR w mniej niż miesiąc, bylibyśmy pewni sukcesów. Gdyby skrócił się średni czas zamykania dużych działów PR o 2 tygodnie, byłby to ogromny sukces”.
- „W idealnej sytuacji nie wykryliśmy żadnych nowych problemów związanych z błędami. Uznaliśmy jednak, że nasz projekt się uda, gdy odnotujemy 50% spadek liczby problemów z błędami”.
Powiązane artykuły
- Jeśli potrzebujesz pomocy przy zadaniach związanych z raportami, przeczytaj przewodnik dla administratorów organizacji.