Obecna faza:
ogłoszono wyniki. Zobacz oś czasu.
Użyj tego przewodnika jako szablonu do stworzenia propozycji projektu dla organizacji.
NAZWA PROPOZYCJI – nazwa organizacji
Tytuł oferty pakietowej powinien być krótki i konkretny. „Aktualizacja przewodnika dla autorów w organizacji ORGNAME” to dobry tytuł propozycji. „Ulepszenia dokumentacji” to zbyt ogólne określenie. „Zaktualizuj sekcje 5, 7, 23 i 99 w Przewodniku dla autorów, sekcji Tworzenie FAQ i Tworzenie przewodnika stylów” to zbyt długie hasło.
Informacje o organizacji
W tej sekcji opisz swoją organizację lub projekt w kilku krótkich akapitach. 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 wywrze pozytywny wpływ na świat i otwarte oprogramowanie.
GloriousPickle (obecna wersja 1.2.3, pierwsza wersja w 2009 r.) to na licencji MIT biblioteka, która umożliwia łatwe obliczenie idealnej zawartości soli, cukru, octu i przypraw do każdego możliwego warzywa peklowanego – w liczbie od pojedynczego ogórka małego do ładunku rzodkiew. Współpracujemy z entuzjastami pikantnych ogórków z całego świata, a nasi użytkownicy to szefowie kuchni, szefowie kuchni w restauracjach oraz osoby pracujące w logistyki w dużych firmach i organizacjach przetwarzających żywność. Największym użytkownikiem naszej organizacji jest organizacja, która pomaga bankom żywności przekształcać z warzyw z krótkiego okresu w stabilne słoiki z korniszonami, nakarmić głodnych ludzi w wielu społecznościach i ograniczać marnowanie żywności. Dodatkowo nasi użytkownicy przesyłają nam opcjonalne dane dotyczące korzystania z GloriousPickle, które wykorzystujemy do tworzenia zbioru PickleSet, czyli dużego zbioru danych służącego do tworzenia nowych przepisów na ogórki konserwowe za pomocą systemów uczących się.
Informacje o projekcie
Problem z Twoim projektem
Opowiedz nam o problemie, który Twój projekt ma rozwiązać. Dlaczego rozwiązanie tego problemu jest ważne dla Twojej organizacji lub projektu?
Użytkownicy chcą mieć możliwość dodawania informacji o nowych przyprawach i innych składnikach (zwłaszcza składnikach z kuchni nieeuropejskich) do narzędzia GloriousPickle. Proces dodawania tych informacji nie jest dobrze udokumentowany, co oznacza, że potencjalni współtwórcy muszą otworzyć problem w projekcie, aby uzyskać pomoc (lub po prostu zrezygnować). Proces zakłada też, że współtwórcy znają już proces żądań pull i GitHub, choć wielu z nich nie jest profesjonalnymi programistami.
Im więcej informacji o składzie, tym bardziej przydatna jest aplikacja GloriousPickle dla wszystkich użytkowników.
Zakres projektu
Powiedz nam, jakie dokumenty Twoja organizacja utworzy, zaktualizuje lub ulepszy. Jeśli jakaś praca nie jest wykonywana celowo, dołącz również tę informację. Podaj szacowany czas realizacji oraz informacje o tym, czy masz już w organizacji wolontariuszy i pisarzy technicznych, którzy będą pracować nad Twoim projektem.
Projekt GloriousPickle (o nazwie kodowej PicklePlus) będzie:
- Przeanalizuj istniejącą dokumentację i utwórz dziennik przeszkód w obecnej dokumentacji dla 3 najczęstszych przypadków użycia (dodawanie nowego składnika i składnika wariantu oraz aktualizowanie i poprawianie informacji o składniku).
- Wykorzystując dziennik niepowodzeń jako przewodnik, który pomoże Ci zrozumieć luki w dokumentacji, utwórz zaktualizowaną dokumentację dla najczęstszych przypadków użycia.
- Utwórz szybką „ściągawkę”, która pomoże w przystosowaniu się do naszych procedur osobom, które dopiero zaczynają korzystać z GitHuba i żądań pull.
- uwzględnić opinie testerów dokumentacji (wolontariuszy w projekcie) i szerszej społeczności GloriousPickle;
- Współpracuj z zespołem ds. wersji, aby zaktualizować dokumentację na stronie GloriousPickle i opracować proces synchronizacji dokumentacji z narzędziem do aktualizacji.
Działania wykraczające poza zakres tego projektu:
- Ten projekt nie stworzy procesu tworzenia linków między różnymi pisowniami lub nazwami tego samego składnika.
- Ten projekt nie utworzy żadnych samouczków na GitHubie. Ściągawka będzie zawierać link do istniejącego materiału, który jest odpowiedni i przydatny.
Mamy 2 kandydatów na stanowisko technicznego copywritera do tego projektu. Szacujemy, że wykonanie tej pracy zajmie 3 miesiące. Twórcy GloriousPickle PickleDocuments SIG i @GloriousPicklePat (główni opiekunowie interfejsu API do dodawania ingredient-adding API) zobowiązali się do wspierania projektu.
Pomiar skuteczności projektu
Jak dowiesz się, że nowa dokumentacja pomogła Ci rozwiązać problem? Jakich danych użyjesz i jak je będziesz śledzić?
GloriousPickle otrzymuje średnio 10 żądań pobrania na kwartał w związku z dodaniem lub zaktualizowaniem nowych składników (otagowanych jako „składnik”). Większość z tych żądań (>60%) pochodzi od poprzednich współtwórców. Wierzymy, że ulepszona dokumentacja spowoduje, że więcej osób będzie wysyłać żądania skompilowania kodu oraz żądania skompilowania kodu od nowych współtwórców. Ponieważ większość naszych aktywnych współtwórców zaczęła od dodawania składników, uważamy, że ulepszenie tej dokumentacji spowoduje, że więcej osób będzie aktywnie uczestniczyć w tworzeniu przepisów.
Po opublikowaniu dokumentacji będziemy co miesiąc śledzić 2 wskaźniki (liczbę zgłoszeń pull związanych ze składnikami i liczbę zgłoszeń pull od nowych współtwórców). Będziemy też co kwartał po opublikowaniu dokumentacji śledzić liczbę osób, które wnieśli więcej niż 3 wkłady.
Projekt uznamy za udany, jeśli po opublikowaniu nowej dokumentacji:
- Liczba żądań pull związanych ze składnikami wzrasta o 20%.
- Liczba żądań pull nowych współtwórców zwiększa się o 15%.
- Liczba osób, które wniosły większy niż 3 wkład, wzrasta o 10% (począwszy od kwartału po opublikowaniu dokumentacji)
Oś czasu
Ile Twoim zdaniem potrwa ten proces? Czy możesz podzielić zadania dla copywritera technicznego według miesiąca lub tygodnia?
Realizacja projektu potrwa około 6 miesięcy. Gdy zatrudnimy copywritera technicznego, poświęcimy miesiąc na jego wdrożenie, a potem przejdziemy do audytu i rejestru problemów. Ostatnie miesiące poświęcimy na tworzenie dokumentacji.
| Daty | Elementy działań |
|---|---|
| Maj | Orientacja |
| Czerwiec–sierpień | Skontroluj istniejącą dokumentację i utwórz dziennik problemów |
| Wrzesień–październik | Tworzenie dokumentacji |
| Listopad | Ukończenie projektu |
Budżet projektu
Ogólne wskazówki
- Budżet możesz uwzględnić w ofercie lub podać 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ć podawane w dolarach amerykańskich. Oczekujemy, że granty będą się wahać od 5000 do 15 tys. USD. Jeśli Twój projekt wykracza poza ten zakres, prześlij dodatkowe informacje, które uzasadnią Twój budżet.
- Spodziewamy się, że większość budżetu (co najmniej 60–70%) zostanie przeznaczona na wynagrodzenia dla copywritera technicznego pracującego nad Twoim projektem. W miarę możliwości zalecamy planowanie budżetu na poszczególne projekty.
- Oczekujemy, że w ramach projektów open source będą w miarę możliwości wykorzystywać narzędzia open source. Jeśli Twój projekt absolutnie wymaga środków na licencje na zastrzeżone oprogramowanie lub wsparcie, podaj uzasadnienie tej kwoty.
- Inne możliwe wydatki to:
- prace projektowe związane z tworzeniem logo, logotypów, szablonów lub innych zasobów projektowych do witryny z dokumentacją;
- Minimalne kwoty (do 200 USD) na gadżety związane z projektem (np. koszulki lub naklejki dla uczestników). Jeśli używasz logo Google Season of Docs, musisz je uzupełnić logo lub nazwą projektu lub organizacji. Na gadżetach nie można używać nazwy Google.
- Minimalne stypendia dla wolontariuszy, którzy biorą udział w dużej roli mentora lub doradcy w projekcie (zalecamy nie więcej niż 500 USD na wolontariusza).
- Darowizny przekazywane innym projektom typu open source nie powinny przekraczać 10% łącznego budżetu.
- W razie potrzeby dodaj inne pozycje budżetu wraz z uzasadnieniem kwoty. Uzasadnienia wydatków powinny wskazywać, w jaki sposób wydatki przyczynią się do powodzenia projektu jako całości.
Przykładowy budżet
| Element budżetu | Kwota | Bieżąca wartość | Uwagi/uzasadnienia |
|---|---|---|---|
| Audyt, aktualizowanie, testowanie i publikowanie nowej dokumentacji procesu dodawania składników w GloriousPickle | 5000,00 | 5000,00 | |
| Stypendia dla wolontariuszy | 500 | 6500,00 | 3 stypendia dla wolontariuszy po 500 zł. |
| T-shirty z projektu (10 szt.) | 150,00 | 6650,00 | |
| Dmuchany jednorożec (15 stóp) | 99,99 | 6749,99 | Dmuchanego jednorożca otrzyma zespół, który najszybciej odpowie na pytania autora treści technicznych w trakcie trwania projektu. |
| ŁĄCZNA LICZBA | 6749,99 |
Dodatkowe informacje
Dołącz tutaj wszelkie dodatkowe informacje związane z Twoją ofertą pakietową.
Wcześniejsze doświadczenie z pracownikami odpowiedzialnymi za dokumentację lub dokumentacją: jeśli Ty lub Twój mentor współpracowaliście wcześniej z pracownikami odpowiedzialnymi za dokumentację lub opracowywaliście dokumentację, wspomnij o tym w swojej aplikacji. Opisz przygotowaną dokumentację i sposób współpracy z autorem treści technicznych. Możesz na przykład opisać procesy kontroli, których użyłaś/użyłeś, lub wyjaśnić, jak umiejętności technicznego autora tekstu pomogły w Twoim projekcie. Wyjaśnij, jak to wcześniejsze doświadczenie może Ci pomóc w pracy z autorem dokumentacji technicznej w ramach Google Season of Docs.
Wcześniejszy udział w sezonie Dokumentów Google, Google Summer of Code lub innych: Jeśli Ty albo któryś z Twoich mentorów braliście udział w programie Google Summer of Code lub podobnym, wspomnij o tym w swoim zgłoszeniu. Opisz swoje osiągnięcia w tym programie. Wyjaśnij, jak te doświadczenia mogą wpłynąć na sposób pracy w ramach Google Season of Docs.