Obecny etap:
Ogłoszenie wyników Oś czasu.
Użyj tego przewodnika jako szablonu do utworzenia oferty projektu dla swojej organizacji.
PROPOSAL TITLE – nazwa organizacji
Tytuł oferty pakietowej powinien być krótki i konkretny. „Zaktualizuj przewodnik dla współtwórcy organizacji ORGNAME” to dobry tytuł oferty pakietowej. Sekcja „Ulepszenia dokumentacji” jest zbyt niejednoznaczna; fragmenty „Aktualizowanie sekcji 5, 7, 23 i 99 Przewodnika dla współtwórców, tworzenia najczęściej zadawanych pytań i przewodnika tworzenia stylu” są zbyt długie.
Informacje o Twojej organizacji
W tej sekcji w kilku krótkich akapitach 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 wywrze pozytywny wpływ na open source i na całym świecie.
GloriousPickle (obecna wersja 1.2.3, pierwsze wydanie w 2009 r.) to licencjonowana przez MIT biblioteka, która umożliwia łatwe obliczanie idealnego stosunku soli, cukru, octu i przypraw w przypadku każdego możliwego warzywa marynowanego – od pojedynczego ogórka małego do ilości rzodkiew w kontenerach. Nasi współtwórcy to miłośnicy ogórków z całego świata, a naszymi użytkownikami są domowy szefowie kuchni, szefowie restauracji i osoby pracujące w logistyce w dużych firmach i organizacjach przetwarzających żywność. Największym użytkownikiem jest organizacja, która pomaga bankom żywności przekształcać warzywa o krótkiej półce czasu w słójki z pikle, wspierając głodnych ludzi w wielu społecznościach i ograniczając marnowanie żywności. Poza tym nasi użytkownicy przesyłają nam opcjonalne dane o tym, jak wykorzystują systemy uczące się GloriousPickle. Wykorzystamy je do produkcji PickleSet – dużego zbioru danych służącego do tworzenia nowych przepisów na marynaty.
Informacje o Twoim projekcie
Problem związany z Twoim projektem
Opowiedz nam, jaki problem pomoże Ci rozwiązać Twój projekt. Dlaczego rozwiązanie tego problemu jest ważne dla Twojej organizacji lub 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ć). Zakładamy też, że współtwórcy znają już nasz proces żądań pull i usługi GitHub, chociaż wielu z naszych użytkowników nie jest profesjonalistami.
Im więcej mamy informacji o składnikach, tym bardziej przydatna jest aplikacja GloriousPickle dla wszystkich naszych użytkowników.
Zakres projektu
Poinformuj nas, jaką dokumentację utworzy, zaktualizuje lub ulepszyć. Jeśli niektóre treści nie są wykonywane celowo, pamiętaj o uwzględnieniu tych informacji. Uwzględnij szacowany czas oraz informację, czy masz już wolontariuszy z organizacji i specjalisty ds. technicznych, którzy będą pracować nad Twoim projektem.
Projekt GloriousPickle (kryptonim PicklePlus) pozwoli:
- Skontroluj dotychczasową dokumentację i stwórz dziennik skrócony dla 3 głównych przypadków użycia (dodawanie nowego składnika, dodawanie wariantu czy aktualizowanie lub poprawianie informacji o składniku).
- Korzystając z dziennika niepowodzeń 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 współtwórcom w pobieraniu żądań, oraz GitHub, aby pomóc im w skorzystaniu z naszego procesu.
- Uwzględnij opinie testerów dokumentacji (wolontariuszy biorących udział w projekcie) i szerszej społeczności GloriousPickle.
- Współpracuj z zespołem ds. wersji, aby zaktualizować dokumentację na stronie GloriousPickle oraz opracować proces synchronizacji dokumentacji z narzędziem do aktualizacji w przyszłości.
Dzieło nieobjęte tym projektem:
- Ten projekt nie utworzy procesu łączenia różnych pisowni lub nazw tego samego składnika.
- Ten projekt nie spowoduje utworzenia żadnych samouczków GitHub. Ściągawka będzie zawierać link do istniejącego materiału, który jest odpowiedni i przydatny.
Do tego projektu mamy 2 dobrych kandydatów do pisania tekstów technicznych. Przewidujemy, że jego wykonanie zajmie około trzech miesięcy. Zespół GloriousPickle PickleDokumentacja SIG i @GloriousPicklePat (główny właściciel interfejsu API dodawania składników) zobowiązali się do wsparcia projektu.
Pomiar sukcesu projektu
Skąd będziesz wiedzieć, że nowa dokumentacja pomogła Ci rozwiązać problem? Jakich danych użyjesz i jak będziesz je śledzić?
GloriousPickle otrzymuje średnio 10 próśb o dodanie lub zaktualizowanie nowych składników (oznaczone tagiem „składnik”). Większość takich żądań (ponad 60%) pochodzi od poprzednich współtwórców. Wierzymy, że po wprowadzeniu ulepszeń w 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 jesteśmy przekonani, że ulepszenie tej dokumentacji przełoży się na większą ogólną liczbę aktywnych współtwórców.
Po opublikowaniu dokumentacji będziemy śledzić co miesiąc dwa rodzaje danych (liczbę żądań pull związanych ze składnikami oraz 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. Zaczynamy po opublikowaniu dokumentacji, co kwartał.
Uznajemy projekt za udany, jeśli po opublikowaniu nowej dokumentacji:
- Liczba żądań pull dotyczących składników zwiększa się o 20%
- Liczba żądań pull od nowych współtwórców rośnie o 15%
- Liczba współpracowników, którzy udostępnili ponad 3 elementy, wzrasta o 10% (początek kwartału po opublikowaniu dokumentacji).
Oś czasu
Jak długo potrwa ten proces? Czy jesteś w stanie rozłożyć zadania pisarza technicznego według miesiąca lub tygodnia?
Ukończenie projektu zajmuje około 6 miesięcy. Po zatrudnieniu autora tekstu spędzimy miesiąc na jego szkoleniu, a potem przejdziemy do dziennika kontrolnego i problemów, a ostatnie miesiące spędzą kilka miesięcy na tworzeniu dokumentacji.
| Daty | Elementy działań |
|---|---|
| Maj | Orientacja |
| Czerwiec–sierpień | Skontroluj istniejącą dokumentację i utwórz dziennik problemów |
| Wrzesień – październik | Utwórz dokumentację |
| listopad | Ukończenie projektu |
Budżet projektu
Ogólne wskazówki
- Możesz podać budżet w ofercie pakietowej lub jako osobny link. Jeśli Twój budżet jest mniejszy niż 10 elementów, zalecamy uwzględnienie go w ofercie.
- Wszystkie budżety powinny być w dolarach amerykańskich. Oczekujemy grantów w wysokości od 5000 USD do 15 000 USD. Jeśli Państwa 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 przeznaczona na twórcę technicznego pracujący nad projektem. W miarę możliwości zalecamy ustalanie budżetu na poziomie poszczególnych projektów.
- Oczekujemy, że projekty open source będą w miarę możliwości wykorzystywać narzędzia open source. Jeśli projekt rzeczywiście wymaga środków na licencje na zastrzeżone oprogramowanie lub pomoc, podaj uzasadnienie kwoty.
- Inne możliwe wydatki to:
- Projektowanie elementów marki, logo, szablonów i innych materiałów na potrzeby witryny z dokumentacją
- Minimalne kwoty (< 200 USD) na gadżety projektowe (koszulki lub naklejki dla uczestników). Jeśli używasz logo Season of Docs, musisz dodać logo lub nazwę Twojego projektu lub organizacji. Twoje gadżety nie mogą zawierać nazwy Google.
- Minimalne stypendia dla wolontariuszy, którzy pełnią w projekcie znaczne role mentorskie lub doradztwa (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 poszukiwanej kwoty. Uzasadnienie kosztów powinno wskazywać, w jaki sposób wydatki przyczynią się do sukcesu całego projektu.
Przykładowy budżet
| Element budżetu | Kwota | Suma bieżąca | Uwagi/uzasadnienia |
|---|---|---|---|
| Audyt pisarzy technicznych, aktualizacja, testowanie i publikowanie nowej dokumentacji procesu dodawania składników do GloriousPickle | 5000 | 5000 | |
| Stypendia wolontariuszy | 500 | 6500.00 | 3 stypendia dla wolontariuszy po 500 USD |
| Koszulki projektu (10 koszulek) | 150.00 | 6650 | |
| Ogromny nadmuchiwany jednorożec (wersja ok. 4,5 metra) | 99,99 EUR | 6749,99 | W czasie prac nad projektem damy nadmuchiwanego jednorożca zespołowi, który odpowiada na pytania pisarza technicznego w czasie prac nad projektem. |
| ŁĄCZNA LICZBA | 6749,99 |
Informacje dodatkowe
Podaj wszelkie dodatkowe informacje, które mają znaczenie w przypadku Twojej oferty.
Wcześniejsza współpraca 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 przygotował dokumentację, wspomnij o tym w zgłoszeniu. Opisz opracowaną dokumentację i sposoby współpracy z tym autorem. Opisz na przykład użyte przez Ciebie procesy recenzowania lub wyjaśnij, jak umiejętności techniczne pisarza przydały się w Twoim projekcie. Wyjaśnij, jak to doświadczenie może pomóc Ci współpracować z autorem treści technicznych w narzędziu Season of Docs.
Wcześniejsze uczestnictwo w programie Season of Docs, Google Summer of Code lub innych: Jeśli Ty lub ktoś z Twoich mentorów braliście udział w Google Summer of Code lub podobnym programie, wspomnij o tym w zgłoszeniu. Opisz swoje osiągnięcia w tym programie. Wyjaśnij, jak może to wpłynąć na sposób pracy w tym czasie.