Fase attuale:
il programma della Stagione dei documenti 2021 è terminato il 14 dicembre 2021. Consulta la cronologia.
Utilizza questa guida come modello per creare la proposta di progetto della tua organizzazione.
PROPOSAL TITLE - organization name
Il titolo della proposta deve essere breve e specifico. "Aggiornamento della guida per i collaboratori di ORGNAME" è un buon titolo per la proposta. "Miglioramenti alla documentazione" è troppo vago; "Aggiorna le sezioni 5, 7, 23, 99 della Guida per i collaboratori, le domande frequenti e la Guida allo stile di Create" è troppo lungo.
Informazioni sulla tua organizzazione
In questa sezione, parlaci della tua organizzazione o del tuo progetto in alcuni brevi paragrafi. Quale problema risolve il tuo progetto? Chi sono i tuoi utenti e collaboratori? Da quanto tempo esiste la tua organizzazione o il tuo progetto? Fornisci un contesto che ci aiuti a capire perché il finanziamento della tua proposta avrebbe un impatto positivo nell'open source e nel mondo.
GloriousPickle (versione corrente 1.2.3, prima release nel 2009) è una libreria con licenza MIT per calcolare facilmente la proporzione perfetta di sale, zucchero, aceto e spezie per ogni possibile verdura sott'aceto, in quantità che vanno da un singolo cetriolo solitario a carichi di ravanelli. I nostri collaboratori sono appassionati di sottaceti provenienti da tutto il mondo, mentre i nostri utenti sono chef casalinghi, chef di ristoranti e persone che lavorano nella logistica per grandi aziende e organizzazioni di trasformazione alimentare. Il nostro utente più grande è un'organizzazione che aiuta i banchi alimentari a trasformare le verdure a breve durata in barattoli stabili di sottaceti, contribuendo a sfamare le persone affamate in molte comunità e a ridurre lo spreco alimentare. Inoltre, i nostri utenti ci inviano metriche facoltative sul loro utilizzo di GloriousPickle, che utilizziamo per produrre PickleSet, un ampio set di dati per la creazione di nuove ricette di sottaceti tramite il machine learning.
Informazioni sul progetto
Il problema del progetto
Descrivi il problema che il tuo progetto contribuirà a risolvere. Perché è importante per la tua organizzazione o il tuo progetto risolvere questo problema?
Gli utenti vogliono poter aggiungere informazioni su nuove spezie e altri ingredienti (in particolare ingredienti di cucine non europee) allo strumento GloriousPickle. Purtroppo, la procedura per aggiungere queste informazioni non è ben documentata, il che significa che i potenziali collaboratori devono aprire un problema nel progetto per ricevere assistenza (o semplicemente rinunciare del tutto). Il processo presuppone inoltre che i collaboratori abbiano già dimestichezza con la nostra procedura di richiesta di pull e con GitHub, anche se molti dei nostri utenti non sono sviluppatori professionisti.
Più informazioni sugli ingredienti abbiamo, più utile è GloriousPickle per tutti i nostri utenti.
Ambito del progetto
Fornisci informazioni sulla documentazione che la tua organizzazione creerà, aggiornerà o migliorerà. Se alcuni lavori non vengono eseguiti deliberatamente, includi anche queste informazioni. Includi una stima del tempo e indica se hai già identificato volontari dell'organizzazione e un redattore tecnico per lavorare al tuo progetto.
Il progetto GloriousPickle (nome in codice PicklePlus) eseguirà le seguenti operazioni:
- Controlla la documentazione esistente e crea un log delle difficoltà della documentazione attuale per i tre casi d'uso principali (aggiunta di un nuovo ingrediente, aggiunta di un ingrediente della variante e aggiornamento o correzione delle informazioni su un ingrediente).
- Utilizzando il log delle difficoltà come guida per comprendere le lacune nella documentazione, crea una documentazione aggiornata per i casi d'uso principali.
- Creare una breve "scheda di riferimento" per aiutare i collaboratori alle prime armi con le richieste di pull e GitHub a utilizzare la nostra procedura.
- Incorporare il feedback dei tester della documentazione (volontari del progetto) e della community più ampia di GloriousPickle.
- Collabora con il team di rilascio per aggiornare la documentazione sul sito GloriousPickle e per creare una procedura per mantenere la documentazione sincronizzata con lo strumento di aggiornamento in futuro.
Attività non coperte da questo progetto:
- Questo progetto non creerà un processo per il collegamento incrociato tra ortografie o nomi diversi per lo stesso ingrediente.
- Questo progetto non creerà tutorial di GitHub, ma il cheat sheet riporterà a materiale esistente pertinente e utile.
Abbiamo due ottimi candidati per la stesura di questo progetto e prevediamo che il lavoro richiederà tre mesi. Il SIG GloriousPickle PickleDocs e @GloriousPicklePat (il maintainer principale dell'API di aggiunta di ingredienti) si sono impegnati a supportare il progetto.
Misurare il successo del progetto
Come fai a sapere che la nuova documentazione ti ha aiutato a risolvere il problema? Quali metriche utilizzerai e come le monitorerai?
GloriousPickle riceve in media dieci richieste pull al trimestre per aggiungere o aggiornare nuovi ingredienti (taggati come "ingrediente"). La maggior parte di queste richieste pull (> 60%) proviene da collaboratori precedenti. Riteniamo che questa documentazione migliorata porterà a un aumento delle richieste pull e a un aumento delle richieste pull da parte di nuovi collaboratori. Poiché la maggior parte dei nostri collaboratori attivi ha iniziato aggiungendo ingredienti, riteniamo inoltre che il miglioramento di questa documentazione porterà a un aumento generale dei collaboratori attivi.
Monitoreremo due metriche (numero di richieste pull relative agli ingredienti e numero di richieste pull da parte di nuovi collaboratori) mensilmente dopo la pubblicazione della documentazione. Monitoreremo anche il numero di collaboratori che hanno fornito più di tre contributi complessivi, a partire dal trimestre successivo alla pubblicazione della documentazione.
Considereremo il progetto riuscito se, dopo la pubblicazione della nuova documentazione:
- Il numero di richieste pull relative agli ingredienti aumenta del 20%
- Il numero di richieste pull da parte di nuovi collaboratori aumenta del 15%
- Il numero di collaboratori che hanno apportato più di 3 contributi aumenta del 10% (a partire dal trimestre successivo alla pubblicazione della documentazione)
Budget del progetto
Linee guida generali
- Puoi includere il budget nella proposta o come link separato. Se il tuo budget è inferiore a dieci articoli, ti consigliamo di includerlo nella proposta.
- Tutti i budget devono essere in dollari statunitensi. Prevediamo che le sovvenzioni varino da 5000 a 15.000 $. Se il tuo progetto non rientra in questo intervallo, fornisci informazioni aggiuntive per giustificare il budget.
- Prevediamo che la maggior parte del budget (almeno il 60-70%) venga allocata al redattore tecnico che lavora al tuo progetto. Ti consigliamo di creare un budget per progetto, se possibile.
- Ci aspettiamo che i progetti open source utilizzino strumenti open source, se possibile. Se il tuo progetto richiede assolutamente fondi per licenze o assistenza di software proprietario, includi una giustificazione dell'importo.
- Altre possibili spese includono:
- Lavori di progettazione per creare branding, loghi, modelli o altri asset di design per il tuo sito di documentazione
- Importi minimi (<200 $) per gadget del progetto (magliette o adesivi per i partecipanti). Se utilizzi il logo della Stagione dei documenti, deve essere accompagnato dal logo o dal nome del progetto o dell'organizzazione. I gadget non possono utilizzare il nome Google.
- Stipendi minimi per i volontari che ricoprono ruoli di tutoraggio o consulenza significativi nel progetto (consigliamo di non superare i 500 $per volontario)
- Le donazioni secondarie ad altri progetti open source non devono superare il 10% del budget totale.
- Includi altri elementi del budget, se necessario, insieme alla motivazione dell'importo richiesto. Le giustificazioni delle spese devono evidenziare in che modo la spesa contribuirà al successo del progetto nel suo complesso.
Budget di esempio
| Elemento del budget | Importo | Totale progressivo | Note/giustificazioni |
|---|---|---|---|
| Il Technical Writer deve controllare, aggiornare, testare e pubblicare nuova documentazione della procedura di aggiunta degli ingredienti per GloriousPickle | 5000,00 | 5000,00 | |
| Stipendi per i volontari | 500 | 6500,00 | 3 stipendi per volontari da 500 € ciascuno |
| Magliette del progetto (10 magliette) | 150,00 | 6650,00 | |
| Unicorno gonfiabile gigante (versione da 4,5 metri) | 99,99 | 6749,99 | L'unicorno gonfiabile verrà assegnato al team che risponde più rapidamente alle domande del redattore tecnico durante il periodo di sviluppo del progetto |
| TOTALE | 6749,99 |
Informazioni aggiuntive
Includi qui eventuali informazioni aggiuntive pertinenti alla tua proposta.
Esperienza pregressa con redattori tecnici o documentazione: se tu o uno dei tuoi mentori avete già lavorato con redattori tecnici o avete sviluppato documentazione, indicatelo nella domanda di partecipazione. Descrivi la documentazione che hai prodotto e le modalità di collaborazione con il Technical Writer. Ad esempio, descrivi le procedure di revisione che hai utilizzato o come le competenze del redattore tecnico sono state utili per il tuo progetto. Spiega in che modo questa esperienza precedente può aiutarti a lavorare con un Technical Writer durante la stagione dei documenti di Google.
Partecipazione precedente a Season of Docs, Google Summer of Code o altri: se tu o uno dei tuoi mentori avete partecipato a Google Summer of Code o a un programma simile, menzionalo nella tua domanda. Descrivi i tuoi risultati in quel programma. Spiega come questa esperienza può influire sul tuo modo di lavorare durante la Stagione dei documenti di Google.