Obecna faza:
finalizacja projektu. 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” są zbyt ogólne; „Zaktualizuj sekcje 5, 7, 23 i 99 w przewodniku dla współtwórców, sekcji Tworzenie często zadawanych pytań oraz sekcji Tworzenie przewodnika po stylach” jest zbyt długi.
Informacje o organizacji
W tej sekcji opisz w kilku krótkich akapitach swoją organizację lub projekt. 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 informacje, które pomogą nam zrozumieć, dlaczego finansowanie Twojej propozycji wywrze pozytywny wpływ na świat i otwarte oprogramowanie.
GloriousPickle (obecna wersja 1.2.3, pierwszy raz opublikowana w 2009 r.) to biblioteka dostępna na licencji 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 ładunek rzepy. Nasze treści są tworzone przez miłośników ogórków z całego świata, a użytkownicy to kucharze domowi, szefowie kuchni i pracownicy specjalizujący się w logistyce w przypadku dużych firm i organizacji zajmujących się przetwórstwem żywności. Nasz największy użytkownik to organizacja, która pomaga bankom żywności przekształcać warzywa o krótkim terminie przydatności do spożycia w stabilne słoiki z ogórecznikami. Dzięki temu można nakarmić głodnych ludzi w wielu społecznościach i zmniejszyć marnowanie żywności. Dodatkowo nasi użytkownicy wysyłają nam opcjonalne dane o swoim korzystaniu 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. Niestety 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, mimo że 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. Podaj szacowany czas realizacji oraz informację, czy masz już wybranych wolontariuszy z organizacji i pisarza technicznego, którzy będą pracować nad Twoim projektem.
Projekt GloriousPickle (o nazwie kodowej PicklePlus) będzie:
- Sprawdź istniejącą dokumentację i utwórz dziennik problemów z bieżącą dokumentacją w przypadku 3 najczęstszych zastosowań (dodanie nowego składnika, dodanie wariantu składnika i aktualizacja lub poprawienie informacji o składniku).
- Na podstawie dziennika problemów stwórz zaktualizowaną dokumentację dla najczęściej używanych przypadków.
- Utwórz krótki „skrót”, który pomoże deweloperom nowym w GitHubie w wykorzystaniu naszego procesu w przypadku żą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 wdrożyć proces utrzymywania zgodności dokumentacji z narzędziem do aktualizacji.
Działania wykraczające poza zakres tego projektu:
- Ten projekt nie stworzy procesu tworzenia hiperłączy między różnymi pisowniami lub nazwami tego samego składnika.
- W ramach tego projektu nie zostaną stworzone żadne samouczki dotyczące GitHuba. Zamiast tego w cheat sheet znajdziesz linki do istniejących materiałów, które są przydatne i trafne.
Mamy 2 bardzo dobrych kandydatów do pracy nad tym projektem. Szacujemy, że zajmie to 3 miesiące. GloriousPickle PickleDocs SIG i @GloriousPicklePat (główny opiekun interfejsu API do dodawania składników) 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 zapytań o przechwycenie w kwartale, aby dodać lub zaktualizować nowe składniki (oznaczone tagiem „składnik”). Większość tych żądań (ponad 60%) pochodzi od poprzednich współtwórców. Wierzymy, że ulepszona dokumentacja zwiększy liczbę żądań skompilowania i liczba nowych współtwórców, którzy je wysyłają. 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 parametry (liczbę żądań pull związanych ze składnikami oraz liczbę żądań 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 udziały.
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ększą liczbę niż 3, zwiększa się o 10% (począwszy od kwartału po opublikowaniu dokumentacji)
Oś czasu
Ile według Ciebie zajmie to zadanie? Czy możesz podzielić zadania związane z pisaniem treści technicznych według miesięcy lub tygodni?
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ń | Sprawdzanie istniejącej dokumentacji i tworzenie dziennika 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 Twój budżet obejmuje mniej niż 10 elementów, zalecamy uwzględnienie go 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, aby uzasadnić swój budżet.
- Spodziewamy się, że większość budżetu (co najmniej 60–70%) zostanie przeznaczona na zatrudnienie copywritera technicznego, który będzie pracować nad Twoim projektem. W miarę możliwości zalecamy planowanie budżetu na poziomie projektu.
- Oczekujemy, że projekty open source będą korzystać z narzędzi open source, o ile to możliwe. Jeśli Twój projekt wymaga środków na licencje na oprogramowanie zastrzeżone lub wsparcie, uzasadnij kwotę.
- Inne możliwe wydatki:
- prace projektowe związane z tworzeniem logo, logotypów, szablonów i innych zasobów projektowych do witryny dokumentacji;
- Minimalne kwoty (mniej niż 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 dołączyć do niego logo lub nazwę projektu lub organizacji. W przypadku gadżetów nie możesz 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 projektu jako całości.
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 | Nadmuchanego 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 tworzyliście dokumentację, wspomnij o tym w swojej aplikacji. Opisz wytworzoną dokumentację i sposób współpracy z pisarzem technicznym. Możesz na przykład opisać procesy kontroli, których używasz, lub wyjaśnić, jak umiejętności technicznego autora tekstów przydały się w Twoim projekcie. Wyjaśnij, jak to doświadczenie może Ci pomóc w pracy z redaktorem technicznym w ramach Google Season of Docs.
Udział w programach Google Season of Docs, Google Summer of Code lub innych: jeśli Ty lub Twój mentor braliście udział w programie Google Summer of Code lub podobnym, wspomnij o tym w swojej aplikacji. Opisz swoje osiągnięcia w tym programie. Wyjaśnij, jak to doświadczenie może wpłynąć na Twoją pracę w ramach Google Season of Docs.