Bieżący etap:
Program Sezon na dokumenty 2021 zakończył się 14 grudnia 2021 r. Zobacz oś czasu.
Użyj tego przewodnika jako szablonu do stworzenia propozycji projektu dla organizacji.
PROPOSAL TITLE - organization name
Tytuł propozycji powinien być krótki i precyzyjny. „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 z 2009 r.) to biblioteka z licencją MIT, która ułatwia obliczanie idealnych proporcji soli, cukru, octu i przypraw do każdego możliwego warzywa nadającego się do ukiszenia, w ilościach od pojedynczego małego ogórka po rzepę w kontenerze. Nasze przepisy pochodzą od miłośników ogórków z całego świata, a użytkownicy to domowi kucharze, szefowie kuchni restauracji oraz osoby pracujące w logistyce w wielkich firmach i organizacjach zajmujących się przetwórstwem żywności. 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 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. Niestety, proces dodawania takich informacji nie jest dobrze udokumentowany, co oznacza, że potencjalni darczyńcy muszą zgłosić problem w projekcie, aby uzyskać pomoc (lub zupełnie się poddać). 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
Podaj informacje o dokumentach, które Twoja organizacja będzie tworzyć, aktualizować lub ulepszać. Jeśli niektóre prace są celowo pomijane, uwzględnij te informacje. Dołącz też szacowany czas pracy i informacje o tym, czy udało Ci się już wyznaczyć wolontariuszy w organizacji i autora tekstów technicznych do pracy nad projektem.
Projekt GloriousPickle (o nazwie kodowej PicklePlus) będzie:
- Przeprowadź audyt dotychczasowej dokumentacji i utwórz dziennik problemów z bieżącą dokumentacją w przypadku 3 najczęstszych zastosowań (dodawanie nowego składnika, dodawanie wariantu składnika i aktualizowanie lub 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ędnij opinie testerów dokumentacji (ochotników biorących udział w projekcie) i szerszej społeczności GloriousPickle.
- Współpracuj z zespołem ds. wersji, aby zaktualizować dokumentację na stronie GloriousPickle i stworzyć proces utrzymywania zgodności 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 pull requestów na kwartał, aby dodać lub zaktualizować nowe składniki (otagowane jako „składnik”). Większość tych pull requestów (ponad 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 zaczynała od dodawania składników, uważamy, że ulepszenie tej dokumentacji spowoduje też ogólną większą liczbę aktywnych współtwórców.
Po opublikowaniu dokumentacji co miesiąc będziemy śledzić 2 rodzaje danych (liczbę żądań pull związanych ze składnikami oraz liczbę żądań pull od nowych darczyńcó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 od nowych współtwórców wzrosła o 15%
- Liczba współtwórców, którzy przesłali więcej niż 3 materiały, zwiększa się o 10% (od początku kwartału po opublikowaniu dokumentacji).
Budżet projektu
Ogólne wskazówki
- Budżet możesz uwzględnić w ofercie lub podać jako osobny link. Jeśli Twój budżet obejmuje mniej niż 10 elementów, zalecamy jego uwzględnienie w ofercie.
- 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 projekty open source będą w miarę możliwości korzystać z narzędzi open source. Jeśli Twój projekt wymaga środków na licencje na oprogramowanie własnościowe lub wsparcie, uzasadnij kwotę.
- 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 Season of Document, musi być mu towarzyszyć logo lub nazwa Twojego projektu lub organizacji. Na gadżetach nie można używać nazwy Google.
- Minimalne stypendia dla wolontariuszy, którzy pełnią w projekcie znaczącą rolę mentora lub przewodnika (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. Uzasadnienie wydatków powinno wskazywać, w jaki sposób wydatki przyczynią się do powodzenia całego projektu.
Przykładowy budżet
| Element budżetu | Kwota | Bieżąca wartość | Uwagi/uzasadnienia |
|---|---|---|---|
| Weryfikacja, aktualizacja, testowanie i publikowanie nowej dokumentacji procesu dodawania składników do GloriousPickle przez technika piszącego | 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
Podaj tutaj wszelkie dodatkowe informacje związane z Twoją propozycją.
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 wytworzoną dokumentację i sposób, w jaki współpracowałeś/współpracowałaś z pisarzem technicznym. 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 programach Season of Docs, Google Summer of Code lub innych: jeśli Ty lub Twój mentor braliście udział w Google Summer of Code lub podobnym programie, wspomnij o tym w swojej aplikacji. 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.