<Nazwa organizacji>: <Rok> Studium przypadku dotyczącego Google Season of Docs
Nazwa organizacji lub projektu:
Link do Season of Docs:
Opis organizacji: 1–2 zdania, które w krótki sposób opisują, czym zajmuje się Twoja organizacja lub projekt.
Autorzy: lista autorów przykładu zastosowania; w razie potrzeby użyj nazw użytkowników (opcjonalnie)
Podsumowanie
Wypełnij poniższą tabelę i krótko odpowiedz na pytania. W późniejszych sekcjach możesz podać więcej szczegółów. Zalecamy najpierw napisanie szczegółowych sekcji, a potem sporządzenie podsumowania.
| # Tech Writers | TW Project Hours | Budżet | % ukończonego projektu |
|---|---|---|---|
| ## | ## | X PLN | X% |
Jaki problem próbowałeś/próbowałaś rozwiązać? Jak próbowałeś/próbowałaś to rozwiązać?
Jakie były wyniki projektu?
Co poszło dobrze? Co zrobisz inaczej?
Jaką radę dałbyś innym projektom, które próbują rozwiązać podobny problem z dokumentacją?
Opis projektu
Opisz projekt, wypełniając poniższe sekcje.
Propozycja projektu
Podaj krótkie podsumowanie oferty i link do strony oferty na stronie projektu.
Proces tworzenia oferty pakietowej
Jak powstała propozycja Google Season of Docs? Jaką metodę zastosowała Twoja organizacja, aby podjąć decyzję dotyczącą pomysłu? Jak zbieraliście i wdrażaliście opinie? Kto brał udział w tym procesie? Ile to zajęło?
Budżet
Odpowiedz na pytania w tabeli poniżej.
| Ile pieniędzy poprosiłeś(-aś) o przekazanie? | |
| Jak obliczono tę kwotę? | |
| Ile godzin pracy zaplanowałeś/zaplanowałaś na ten projekt? | |
| Ile godzin pracy było faktycznie potrzebnych do wykonania projektu? | |
| Jakie inne wydatki uwzględniłeś/uwzględniłaś w budżecie? | |
| Czy podczas realizacji projektu pojawiły się jakieś niespodziewane wydatki (np. błędne oszacowanie budżetu)? Jeśli tak, opisz to. |
Rekrutacja pisarzy technicznych
Jak znalazłeś(-aś) i zatrudniłeś(-aś) copywritera technicznego? Czy proces przebiegł prawidłowo? Czy byli obecni przez cały czas trwania projektu?
Inni uczestnicy
Kto jeszcze pracował nad tym projektem (w przypadku prośby uczestników podaj ich nazwy użytkownika)? Jak ich pozyskałeś? Jakie pełniły role? Czy pozostali w projekcie do samego końca?
Oś czasu
Podaj krótki przegląd harmonogramu projektu (wskaż przewidywany termin zakończenia lub etapy pośrednie, jeśli projekt jest w toku). Czy oryginalny harmonogram wymagał korekty?
Dostarczane materiały
Wypełnij tabele, aby opisać, co zostało utworzone, zaktualizowane lub w inny sposób zmienione podczas projektu. Obejmują zarówno zaplanowane, jak i nieplanowane produkty. Pamiętaj, aby uwzględnić rzeczy, które zostały zaplanowane, ale nie zostały ukończone.
Planowane wyniki
Odpowiednie linki mogą obejmować opublikowane dokumenty, prośby o przechwycenie lub inne artefakty.
| Realizacja | Ukończono % | Powiązane linki | Uwagi |
|---|---|---|---|
| Element 1 | |||
| … | |||
| Deliverable #N |
Nieplanowane materiały
Czy zostały utworzone jakieś produkty, które nie były planowane na początku projektu? Jeśli tak, wyjaśnij to.
Dane
Jakie wskaźniki wybrałeś/wybrałaś do pomiaru skuteczności projektu? Czy udało Ci się zebrać te dane? Czy w wyniku projektu zauważyłeś/zauważyłaś jakieś zmiany? Czy od czasu przesłania oferty dodano lub usunięto jakieś dane? Jak często zamierzasz zbierać dane?
Analiza
Podaj krótki opis tego, jak przebiegał projekt. Czy projekt był udany? Dlaczego? Kiedy będzie można ocenić skuteczność? Czy napotkałeś/napotkałaś jakieś nieoczekiwane przeszkody lub niepowodzenia? Czy w Twojej organizacji w wyniku projektu wdrożone zostały nowe lub zaktualizowane procesy i procedury?
Wnioski
Skorzystaj z tych tabel, aby podkreślić wnioski – zarówno te dotyczące tego, co poszło dobrze, jak i tego, co można było zrobić lepiej. Użyj wymienionych kategorii tematów lub dodaj własne. W razie potrzeby możesz użyć kilku wierszy dla danego tematu. Te wnioski zostaną uwzględnione na naszej zbiorczej liście sprawdzonych metod dotyczących projektów związanych z dokumentacją.
Co poszło dobrze?
W ramach lekcji wyciągniętych wniosków możesz dodać własne spostrzeżenia lub wskazać „plus jeden” w przypadku dotychczasowych najlepszych praktyk z Google Season of Docs.
| Temat | Nasze osiągnięcia | Wnioski |
|---|---|---|
| Budżet | ||
| Komunikacja | ||
| Opieka mentora | ||
| Dane | ||
| Wprowadzenie | ||
| Uczestnicy | ||
| Wyniki projektu | ||
| Zarządzanie projektami | ||
| Rekrutacja i zatrudnianie | ||
| … | ||
| <Inne tematy, jeśli to konieczne> | ||
Co można by poprawić?
W ramach lekcji wyciągniętych wniosków możesz dodać własne spostrzeżenia lub wskazać „plus jeden” w przypadku dotychczasowych najlepszych praktyk z Google Season of Docs.
| Temat | Nasze osiągnięcia | Co zrobilibyśmy inaczej | Wnioski |
|---|---|---|---|
| Budżet | |||
| Komunikacja | |||
| Opieka mentora | |||
| Dane | |||
| Wprowadzenie | |||
| Uczestnicy | |||
| Wyniki projektu | |||
| Zarządzanie projektami | |||
| Rekrutacja i zatrudnianie | |||
| … | |||
| <Inne tematy, jeśli to konieczne> | |||
Dodatek
Jeśli masz inne materiały, do których chcesz dodać link (np. jeśli masz umowę na współpracę z Twoim autorem technicznym, którą chcesz udostępnić, lub szablony projektu dokumentacji albo inne otwarte zasoby dokumentacji, możesz je tutaj wymienić i dodać do nich linki). W załączniku możesz też podać linki do narzędzi lub zasobów dokumentacji, których użyłeś/użyłaś, a także podziękowania lub podziękowania, które nie pasują do poprzednich sekcji.