Tworzenie studium przypadku

Obecny etap:
Program Sezon Dokumentów 2021 zakończył się 14 grudnia 2021 r. Zobacz oś czasu.

W sezonie Dokumentów 2021 organizacje muszą przesłać końcową ocenę oraz studium przypadku. Aby utworzyć studium przypadku we własnym projekcie, skorzystaj z naszego szablonu studium przypadku i przykładowego studium przypadku.

Ostateczny formularz oceny będzie dostępny co najmniej miesiąc przed 30 listopada 2021 r. o godz. 18:00 czasu UTC.

Przegląd studium przypadku

Szablon studium przypadku będzie zawierał te sekcje:

  • Pytanie: jaki problem próbowałeś(-aś) rozwiązać przy użyciu nowej lub poprawionej dokumentacji?
  • Streszczenie oferty: krótkie podsumowanie pierwotnej propozycji organizacji
  • Opis projektu: krótki opis projektu. Uwzględnij:
    • sposób utworzenia oferty (i link do strony z oryginalnymi pomysłami na projekt).
    • Sposób rekrutacji i wyboru redaktorów technicznych lub innych uczestników.
    • kto pracował nad projektem (użyj nazw użytkowników, jeśli poprosili o to uczestnicy);
    • Ile czasu zajmuje ukończenie projektu (jeśli został ukończony).
    • Co Ci się podobało?
    • Co było nieoczekiwane? Z jakimi przeszkodami lub przeciwnościami się spotkałeś(-aś)?
    • Jaka dokumentacja została utworzona, zaktualizowana, udoskonalona lub usunięta?
  • Czy ten projekt zaowocował nowymi lub zaktualizowanymi procesami lub procedurami w Twojej organizacji?
  • Dane:
    • Jakie wskaźniki zostały wybrane do pomiaru powodzenia projektu?
    • Czy udało Ci się zebrać te dane?
    • Czy były one związane z oczekiwanymi przez Ciebie zachowaniami lub testami porównawczymi?
    • Czy wybrane przez Ciebie dane się zmieniły? Czy zostały usunięte lub dodane jakieś dane?
    • Czy Twój projekt jest udany, według wskaźników? Może być zbyt wcześnie, aby to określić.
    • Jak często zamierzasz zbierać dane w przyszłości?
  • Podsumowanie:
    • W 2–4 akapitach podsumuj wrażenia związane z projektem. Czego się nauczyłeś? Co Twoim zdaniem możesz robić inaczej w przyszłości? Jakich rad możesz udzielić projektom, które próbują rozwiązać podobny problem, korzystając z dokumentacji?

Studium przypadku

  • Cotygodniowy dziennik aktualizacji dotyczących projektu ułatwi Ci stworzenie studium przypadku. W każdym tygodniu rejestruj postępy projektu (w tym linki do żądań, problemy lub rozmowy, jeśli są potrzebne), co poszło dobrze, a co nie, czego się dowiedziałeś(-aś) i zadane pytania.
  • Pisząc studium przypadku, zachowaj uprzejmość. Unikaj obwiniania użytkowników i trzymaj się konstruktywnych wypowiedzi. Pamiętaj, że studia przypadków są publiczne.
  • W swoim studium przypadku użyj tego samego tonu co w poście na blogu czy w samouczku. Nie używaj zbyt formalnej formy.