Pytanie:
Czy powinienem złożyć moje listy kontrolne jako dokumentację?
Rarity
2012-04-13 21:04:52 UTC
view on stackexchange narkive permalink

Prowadzę wiele małych list kontrolnych rzeczy do zrobienia. Trzymałem je w notatniku i wyrzucałem strony, kiedy były gotowe. Teraz używam aplikacji na iPada, więc moja historia jest zawsze przechowywana, ale nie zapisuję jej w żadnej oficjalnej dokumentacji.

Jestem programistą, więc większość mojej pracy jest dokumentowana za pomocą kontroli wersji , ale jest wiele drobnych poprawek do oprogramowania bez kontroli wersji, zmian w bazach danych i sprawdzeń, które wykonuję, gdy pełnię również rolę pomocniczą.

Próbowaliśmy udokumentować to, co robimy w moim dziale, więc pomysł przyszedł mi do głowy, ale moje zmiany nie są tymi, które powodują problemy.

Czy mam zachować listę zadań jako rodzaj oficjalnej dokumentacji? Jak mogę się upewnić, że jest to przydatne dla kogoś innego niż ja?

Dlaczego zmiany bazy danych nie miałyby być objęte kontrolą źródła? A dlaczego nie sprawdzić skryptów, których używasz do sprawdzania?
@HLGEM Pracuję nad tym, żeby to zacząć, ale nie chodzi tylko o bazę danych
Siedem odpowiedzi:
#1
+8
Tech Lover in NYC
2012-04-14 09:00:07 UTC
view on stackexchange narkive permalink

Wygląda na to, że Twój dział stara się lepiej śledzić, kto co robi i co się robi, więc w tym celu powiedziałbym, że tak, powinieneś ich zachować. To powiedziawszy, wygląda na to, że w formacie, w którym się znajdują, nie będą przydatne dla wielu innych osób, ponieważ mogą to być losowe zbiory dużych i małych zadań z niewielką ilością powiązanych informacji lub tagów.

Jeśli istnieją to skoordynowany wysiłek w Twoim dziale, aby śledzić i dokumentować więcej, brzmi to jak dobry moment, aby zacząć używać do tego oprogramowania. Jedną z ogromnych zalet korzystania z usług takich jak Fogbugz, Teambox, Trello, Pivotal Tracker itp. Jest to, że wszystko, co robisz, staje się możliwe do przeszukiwania zarówno dla Ciebie, jak i dla wszystkich obecnych lub przyszłych członków zespołu. Chcesz zobaczyć, jak ktoś po raz pierwszy poradził sobie z konkretnym problemem lub czy często się on pojawia? Poszukaj go i zobacz, co się pojawi.

Osobiście wdrożyłem Teambox w swoim miejscu pracy i zachęcam współpracowników do używania go do wspólnych zadań. Ale używam go również do rzeczy, które tylko ja muszę śledzić, wiedząc, że ktokolwiek będzie odgrywał moją rolę w przyszłości (nawet jeśli to ja!), Może docenić tę historię, jak niektóre rzeczy były załatwiane wcześniej.

Wiele z tych systemów jest dość szybkich i łatwych w użyciu i integruje strumień komentarzy, dzięki czemu aktualizacje i dyskusje wokół zadania są przechowywane w tym zadaniu. Ponadto, jeśli istnieją powtarzalne listy zadań, wiele z tych systemów umożliwia przechowywanie ich jako szablonu.

Użyj systemu zgłoszeń (zwanego również śledzeniem problemów: takim jak Trello, Jira ... itd.).
#2
+6
Brandon
2012-04-13 21:59:26 UTC
view on stackexchange narkive permalink

Miałem podobną sytuację u mojego poprzedniego pracodawcy. Skończyło się na tym, że zacząłem pisać na naszej wiki za każdym razem, gdy miałem nowy nietrywialny problem ze wsparciem, z którym miałem do czynienia. To było trochę pouczające, ponieważ była tam znaczna ilość informacji, które właśnie zinternalizowałem. Nawet drobne problemy naprawdę zakładają, że masz przynajmniej pewien poziom wiedzy instytucjonalnej.

Trudno to zrobić na początku, ale potem jest to trochę miłe, ponieważ możesz wziąć wakacje i być może dostać jeden telefon zadzwoń zamiast 3-4 dziennie. :)

To brzmi jak dużo więcej niż prosta lista kontrolna.
Żałuję, że nie mamy Wiki, podobał mi się pomysł wiki w systemie biletowym. Wszystko, co mamy, to strasznie posortowane dokumenty słowne
@FrustratedWithFormsDesigner Tak - moje codzienne sprawy mogą być dla mnie listą kontrolną, ale nie będą dla kogoś innego. Prawdopodobnie będą potrzebować pół strony informacji ogólnych, aby zrozumieć, co się dzieje.
@Rarity Skonfiguruj. Zainstaluj IIS na serwerze deweloperskim, chwyć Instalatora platformy Windows i zainstaluj ScrewTurn i po prostu uruchom z nim. Wolę prosić o przebaczenie niż o pozwolenie. :)
@Brandon Przeniosłem nas z Apache, aby odciągnąć nas od Instalatora platformy Windows! Próba użycia PHP z tego czegoś była koszmarem ...
@Rarity Sam jestem facetem od Windows .NET, więc domyślnie korzystałem z WPI, ale rozumiem, skąd pochodzisz. Rzuć MediaWiki w skrzynkę Apache i idź do miasta. :)
#3
+3
voretaq7
2012-04-13 23:09:05 UTC
view on stackexchange narkive permalink

Powiedziałbym, że powinieneś dokumentować wszystko, co robisz. Jeśli jedyną dokumentacją jest lista kontrolna, to tak, należy ją jakoś zapisać.

Uwaga na temat terminologii, nie mówię o „dokumentacji” w sensie, że ktoś inny odwołuje się do niej później, ja Mówię o zapisie twoich działań, nadającym się do wspomnienia podczas przeglądu wyników. Prowadzenie listy tego, co zrobiłeś, pomoże ci złożyć oświadczenie o osiągnięciach, a jeśli przegapiłeś ważne cele, da ci wyobrażenie o innych zadaniach, które sprawiły, że cele / terminy się poślizgnęły.

#4
+2
FrustratedWithFormsDesigner
2012-04-13 21:21:46 UTC
view on stackexchange narkive permalink

Może. Myślę, że najbardziej przydatne byłoby szkolenie pracowników do podejmowania nowych zadań, których nie znają. Na przykład rozwiązywanie problemów z konkretną klasą problemów może obejmować przejście przez kilka kroków i użycie listy kontrolnej w celu wyeliminowania pewnych sytuacji. Lista kontrolna może być również przydatna w przypadku zadań, takich jak wdrażanie skomplikowanego kodu lub zmiany na serwerze. Widziałem proste listy kontrolne w dokumentacji przewodników konfiguracyjnych dla programistów, dotyczące konfigurowania środowiska dla bardziej złożonych projektów.

Wadą listy kontrolnej jest sytuacja, gdy osoba wykonująca ją nieświadomie korzysta z wystąpienia zadania, które odbiega nieco od tego, co zakłada lista kontrolna. Miejmy jednak nadzieję, że nie stanie się to, dopóki osoba nie będzie na tyle uzdolniona, by nie potrzebować listy kontrolnej i podejmować własnych decyzji.

Chcesz także uniknąć uzależnienia ludzi od listy kontrolnej, więc może nie Nie czyń tego zbyt szczegółowym - może napisz to bardziej jako przewodnik wysokiego poziomu, chyba że konkretne zadanie nie ulegnie zmianie i konieczne są dogłębne szczegóły.

Niestety, moje listy kontrolne są bardziej przeznaczone tylko dla mnie, wymagałoby to znacznego przepisania, aby były przydatne dla innych. zwłaszcza, że ​​coś więcej niż „to, co ostatnio robiłem”
@Rarity: Czy są one przynajmniej powtarzalne, tak abyś mógł ich użyć ponownie w przyszłości, aby uniknąć konieczności ponownego wymyślania wszystkiego?
Na razie nie są one zwykle dzielone na pod-zadania. Jeśli coś jest naprawdę skomplikowane, umieszczam to w prawdziwym dokumencie, na przykład jak zainstalować nasz serwer.
@Rarity: Przydatne tylko dla Ciebie, do zadań, których nie można powtórzyć ... Na podstawie tego, jak je opisałeś, myślę, że możesz uzyskać więcej pożytku, wypełniając listy zakupów spożywczych jako dokumentację. Przynajmniej są one * czasami * powtarzalne. ;)
#5
+1
IDrinkandIKnowThings
2012-04-13 23:50:23 UTC
view on stackexchange narkive permalink

Należy sprawdzić zasady przechowywania dokumentów w swojej firmie. Niektóre firmy mogą wymagać ich zachowania, inne nie. Powodem jest to, że po pewnym czasie można je uznać za możliwe do odnalezienia dokumenty na potrzeby postępowania sądowego. Te różnią się w zależności od firmy. Pracowałem w firmach, które przez 5 lat uznawały każdy dokument za dokument wymagający zachowania. Nawet jeśli było to menu używane do wyjmowania, które nie było nabazgrane.

Z Wikipedii

Okres przechowywania dokumentu jest aspektem zarządzania rekordami. Wskazuje okres czasu, w którym dokument powinien być przechowywany lub „przechowywany” zarówno w formie elektronicznej, jak i papierowej. Po zakończeniu okresu przechowywania dokument jest zwykle niszczony. Termin ten jest powszechnie używany przez księgowych i specjalistów podatkowych, których zawód wiąże się z dokumentami prawnymi, które muszą istnieć tylko przez określony czas. Okres przechowywania jest różny dla różnych typów rekordów. Na przykład dokumenty założycielskie firmy mają stały okres przechowywania (co oznacza, że ​​powinny zostać zachowane i nigdy nie mogą zostać zniszczone), ale pokwitowania za zakupy odliczane od podatku dokonywane przez indywidualnego podatnika zwykle mają trzyletni okres przechowywania (i często można je bezpiecznie wyrzucić po tym momencie.) Długość okresu przechowywania różni się w zależności od branży i opiera się na prawdopodobieństwie, że dokument będzie potrzebny w przyszłości ze względów prawnych. Rekordy, które nie będą służyć żadnemu dalszemu celowi (określonemu przez długość okresu ich przechowywania), są niszczone z powodu problemów z przestrzenią, zwykle przez niszczarki do papieru.

#6
+1
Reinstate Monica - Goodbye SE
2012-04-14 16:48:30 UTC
view on stackexchange narkive permalink

Aby najpierw odpowiedzieć na ostatnie pytanie, dowiesz się, czy inne osoby są zainteresowane, po udokumentowaniu go w miejscu, w którym inni mogą je zobaczyć.

Moja sugestia: udokumentuj to na wiki, gdzie każdy może to zobaczyć. Możesz umieścić to na stronie jako „oficjalną” procedurę dotyczącą Twojego stanowiska lub na stronie osobistej. Ale wtedy przynajmniej inni ludzie mogą to zobaczyć, kiedy Cię nie ma i przejmą Twoje zadania. A ludzie na podobnych stanowiskach w całej firmie mogą je recenzować i wymieniać się pomysłami.

Kluczem jest upublicznienie i łatwość aktualizacji (i dostępu, nawet przez iPada).

#7
  0
JohnFx
2012-04-13 23:38:37 UTC
view on stackexchange narkive permalink

Czy masz system śledzenia spraw, taki jak Bugzilla lub FogBugz? Pracuję w zespole programistycznym i używamy naszych instancji FogBugz do ogólnych zadań oprócz błędów / żądań funkcji i działa całkiem dobrze.

To mały system i praktycznie jednoosobowy zespół dla każdej poprawki, więc nie używamy narzędzia do śledzenia błędów, po prostu wysyłamy wiadomości. Nie było to na tyle duży problem, aby ktoś inny użył narzędzia do śledzenia błędów.
Właściwie możesz mieć wtedy szczęście. FogBugz (i prawdopodobnie inni) pozwolą Ci korzystać z hostowanej wersji ich narzędzia bezpłatnie, jeśli masz mniej niż 2 użytkowników (http://www.fogcreek.com/fogbugz/StudentAndStartup.html)


To pytanie i odpowiedź zostało automatycznie przetłumaczone z języka angielskiego.Oryginalna treść jest dostępna na stackexchange, za co dziękujemy za licencję cc by-sa 3.0, w ramach której jest rozpowszechniana.
Loading...