Obecny etap:
opracowywanie dokumentacji. Sprawdź oś czasu.
Użyj tego przewodnika jako szablonu do utworzenia propozycji projektów swojej organizacji.
PROPOSAL TITLE – nazwa organizacji
Tytuł oferty pakietowej powinien być krótki i konkretny. Dobrym tytułem oferty jest „Aktualizowanie przewodnika dla współtwórców w organizacji ORGNAME”. Szablon „Dokumentacja ulepszenia” jest zbyt niejednoznaczny,a tekst „Aktualizowanie sekcji 5,7,23, 99 Przewodnika dla współtwórców, tworzenia odpowiedzi na najczęstsze pytania i tworzenia przewodnika” jest za długie.
Informacje o Twojej organizacji
W tej sekcji krótko opowiedz nam o swojej organizacji lub projekcie. Jaki problem rozwiązuje Twój projekt? Kim są Twoi użytkownicy i współtwórcy? Od jak dawna istnieje Twoja organizacja lub projekt? Podaj kontekst, który pomoże nam zrozumieć, dlaczego finansowanie Twojej propozycji miałoby pozytywny wpływ na oprogramowanie open source i na całym świecie.
GloriousPickle (obecna wersja 1.2.3, pierwsza wersja w 2009 r.) to biblioteka na licencji MIT umożliwiająca łatwe obliczanie idealnego stosunku soli, cukru, octu i przypraw w przypadku każdego możliwego warzywa marynowanego – od pojedynczych ogórków do rzodkiew w kontenerach. Naszymi współtwórcami są miłośnicy ogórków z całego świata, a naszymi użytkownikami są szefowie kuchni, szefowie restauracji i osoby pracujące w logistyce w dużych firmach i organizacjach przetwarzających żywność. Największy z naszych użytkowników to organizacja, która pomaga bankom żywności przekształcać warzywa o krótkiej dostępności w słoiki z pikle, pomagając w karmieniu głodnych ludzi w wielu społecznościach i ograniczając ilość marnowanej żywności. Dodatkowo użytkownicy przesyłają nam opcjonalne dane o tym, jak wykorzystują GloriousPickle. Wykorzystamy je do wygenerowania PickleSet – dużego zbioru danych do tworzenia nowych przepisów na marynaty za pomocą systemów uczących się.
Informacje o projekcie
Problem z Twoim projektem
Opowiedz nam, jaki problem może rozwiązać Twój projekt. Dlaczego rozwiązanie tego problemu jest ważne dla Twojej organizacji lub Twojego projektu?
Użytkownicy chcą mieć możliwość dodawania do narzędzia GloriousPickle informacji o nowych przyprawach i innych składnikach (zwłaszcza składników z kuchni pozaeuropejskiej). Niestety proces dodawania tych informacji nie jest dobrze udokumentowany, co oznacza, że potencjalni współtwórcy muszą rozwiązać problem w projekcie, aby uzyskać pomoc (lub po prostu się poddać). W procesie zakładamy też, że współtwórcy znają już nasz proces żądania pull i usługi GitHub, chociaż wielu z naszych użytkowników nie jest profesjonalnymi programistami.
Im więcej mamy informacji o składnikach, tym bardziej przydatny jest produkt GloriousPickle dla wszystkich naszych użytkowników.
Zakres projektu
Powiedz nam, jaka dokumentacja zostanie stworzona, zaktualizowana lub udoskonalona przez Twoją organizację. Jeśli ktoś celowo nie wykonuje jakiejś pracy, też podaj te informacje. Podaj szacowany czas i sprawdź, czy udało Ci się już znaleźć wolontariuszy i specjalistów ds. technicznych do pracy nad Twoim projektem.
Projekt GloriousPickle (kryptonim PicklePlus) będzie:
- Skontroluj istniejącą dokumentację i stwórz dziennik niejasny dotyczący 3 najpopularniejszych przypadków użycia (dodawanie nowego składnika, dodawanie wariantu do składnika oraz aktualizowanie lub poprawianie informacji o składniku).
- Korzystając z dziennika konfliktów jako przewodnika do zrozumienia luk w dokumentacji, utwórz zaktualizowaną dokumentację dotyczącą najczęstszych przypadków użycia.
- Utwórz krótką ściągawkę, aby pomóc nowym współtwórcom w pobieraniu żądań, a na GitHubie ułatwisz im korzystanie z naszego procesu.
- Uwzględnij opinie testerów dokumentacji (wolontariuszy biorących udział w projekcie) i szerszej społeczności GloriousPickle.
- Podejmij współpracę z zespołem ds. wersji, aby zaktualizować dokumentację witryny GloriousPickle i opracować proces synchronizacji dokumentacji z narzędziem do aktualizacji.
Zadanie, które jest poza zakresem tego projektu:
- Ten projekt nie utworzy procesu łączenia różnych pisowni lub nazw tego samego składnika.
- Ten projekt nie będzie tworzyć żadnych samouczków GitHub. Ściągawka będzie zawierać link do istniejącego materiału, który jest przydatny.
Do tego projektu mamy 2 dobrze znane teksty techniczne. Jego ukończenie zajmie około 3 miesięcy. Organizacja GloriousPickle PickleDocuments SIG i @GloriousPicklePat (główna osoba zarządzająca interfejsem API dodawania składników) zobowiązały się do pomocy w tym projekcie.
Pomiar sukcesu projektu
Skąd będziesz wiedzieć, że nowa dokumentacja pomogła Ci rozwiązać problem? Jakie dane zostaną wykorzystane i jak je śledzić?
GloriousPickle otrzymuje średnio 10 próśb o dodanie lub zaktualizowanie nowych składników (oznaczone tagiem „składnik”). Większość tych żądań pull (>60%) pochodzi od poprzednich współtwórców. Wierzymy, że dzięki tej ulepszonej dokumentacji pojawi się więcej żądań pull i więcej od nowych współtwórców. Większość aktywnych współtwórców zaczęła od dodawania składników, dlatego sądzimy, że ulepszenie tej dokumentacji przyczyni się do zwiększenia ogólnej liczby aktywnych współtwórców.
Po opublikowaniu dokumentacji będziemy co miesiąc śledzić 2 wskaźniki (liczba żądań pull związanych ze składnikami i liczbę żądań pull od nowych współtwórców). Będziemy też śledzić liczbę współpracowników, którzy wprowadzili łącznie więcej niż 3 darowizny, zaczynając od kwartału po opublikowaniu dokumentacji.
Uznajemy projekt za udany, jeśli po opublikowaniu nowej dokumentacji:
- Liczba żądań pull związanych ze składnikami wzrasta o 20%.
- Liczba żądań pull od nowych współtwórców rośnie o 15%
- Liczba współtwórców, którzy przekazali ponad 3 darowizny, wzrasta o 10% (na początku kwartału po opublikowaniu dokumentacji).
Oś czasu
Jak długo potrwa ten proces? Czy jesteś w stanie podzielić zadania pisarza technicznego według miesiąca lub tygodnia?
Ukończenie samego projektu zajmuje około 6 miesięcy. Po zatrudnieniu autora tekstu spędzimy miesiąc na jego szkoleniu, potem przejdziemy do dziennika kontrolnego i dziennika błędów, a ostatnie miesiące spędzimy kilka miesięcy na tworzeniu dokumentacji.
| Daty | Elementy działań |
|---|---|
| Maj | Orientacja |
| Czerwiec–sierpień | Sprawdź istniejącą dokumentację i utwórz dziennik błędów |
| Wrzesień–październik | Utwórz dokumentację |
| Listopad | Zakończenie projektu |
Budżet projektu
Ogólne wskazówki
- Budżet możesz podać w ofercie pakietowej lub jako osobny link. Jeśli budżet jest mniejszy niż 10 elementów, zalecamy uwzględnienie go w ofercie pakietowej.
- Wszystkie budżety powinny być w dolarach amerykańskich. Przewidujemy, że granty będą się mieścić w przedziale od 5000 USD do 15 000 USD. Jeśli projekt wykracza poza ten zakres, należy podać dodatkowe informacje uzasadniające budżet.
- Spodziewamy się, że znaczna część Twojego budżetu (minimum 60–70%) zostanie przydzielona do specjalistki ds. technicznych pracujących nad Twoim projektem. Zalecamy ustalanie budżetu na poszczególne projekty w miarę możliwości.
- Oczekujemy, że projekty open source będą w miarę możliwości korzystać z narzędzi open source. Jeśli projekt absolutnie wymaga środków na licencje na zastrzeżone oprogramowanie lub pomoc, podaj uzasadnienie kwoty.
- Inne możliwe wydatki to:
- Projektuj elementy marki, logo, szablony i inne zasoby przeznaczone do witryny z dokumentacją
- Minimalne kwoty (< 200 USD) na gadżety projektowe (koszulki lub naklejki dla uczestników). Jeśli używasz logo Sezonu Dokumentów Google, musi ono towarzyszyć logo lub nazwie Twojego projektu lub organizacji. Gadżety nie mogą zawierać nazwy Google.
- Minimalne stypendia dla wolontariuszy, którzy zajmują się doradztwem i opieką mentorską w projekcie (zalecamy nie więcej niż 500 USD na wolontariusza).
- Darowizny na rzecz innych projektów open source nie powinny przekraczać 10% łącznego budżetu.
- W razie potrzeby uwzględnij inne elementy budżetu wraz z uzasadnieniem żądanej kwoty. Uzasadnienie wydatków powinno wskazywać, jak wydatki przyczynią się do sukcesu całego projektu.
Przykładowy budżet
| Element budżetu | Kwota | Suma bieżąca | Uwagi/uzasadnienia |
|---|---|---|---|
| Audyt, aktualizacja, testowanie i publikowanie nowej dokumentacji procesu dodawania składników w GloriousPickle | 5000 | 5000 | |
| Stypendia wolontariuszy | 500 | 6500 | 3 stypendia wolontariuszy, każde po 500 USD |
| Koszulki projektu (10 koszulek) | 150 | 6650 | |
| Ogromny nadmuchiwany jednorożec (wersja 4,5 metra) | 99,99 EUR | 6749,99 | W okresie opracowywania projektu damy nadmuchiwanego jednorożca zespołowi, który odpowiada na pytania pisarza technicznego najszybciej. |
| ŁĄCZNA LICZBA | 6749,99 |
Informacje dodatkowe
Podaj wszelkie dodatkowe informacje istotne dla Twojej oferty.
Wcześniejsze doświadczenia związane z pracą z twórcami treści technicznych lub dokumentacją: jeśli Ty lub ktoś z Twoich mentorów współpracował już z twórcami technicznymi lub tworzyliście dokumentację, wspomnij o tym w zgłoszeniu. Opisz opracowaną dokumentację i sposoby współpracy z autorem treści technicznych. Na przykład opisz zastosowane procesy recenzowania lub wyjaśnij, jak umiejętności pisarza techniczne przydały się w Twoim projekcie. Wyjaśnij, jak to doświadczenie może pomóc Ci współpracować z twórcą treści technicznych w sezonie Dokumentów Google.
Wcześniejsze uczestnictwo w tym sezonie w Dokumentach Google, „Google Summer of Code” lub w innych: Jeśli Ty lub ktoś z Twoich mentorów braliście udział w Google Summer of Code lub w podobnym programie, wspomnij o tym w zgłoszeniu. Opisz swoje osiągnięcia w tym programie. Wyjaśnij, w jaki sposób ta zmiana może wpłynąć na sposób pracy w sezonie Dokumentów Google.