Fase attuale:
Risultati annunciati
tempistiche.
Utilizza questa guida come modello per creare una proposta di progetto per la tua organizzazione.
TITOLO PROPOSTA - nome organizzazione
Il titolo della proposta deve essere breve e specifico. "Aggiorna Guida per collaboratori di ORGNAME" è un buon titolo per la proposta. "Documentazione miglioramenti" è troppo vaga; "Aggiorna sezioni 5,7,23,99 della Guida per i collaboratori, Creare domande frequenti e Creare guida di stile" è troppo lungo.
Informazioni sulla tua organizzazione
In questa sezione, descrivici la tua organizzazione o il tuo progetto in pochi brevi paragrafi. Quale problema risolve il tuo progetto? Chi sono gli utenti e i collaboratori? Da quanto tempo esiste la tua organizzazione o il tuo progetto? Fornisci un contesto per aiutarci a capire perché il finanziamento della tua proposta creerebbe un impatto positivo sull'open source e nel mondo.
Glorious Pickle (versione attuale 1.2.3, prima release nel 2009) è una libreria con licenza MIT per calcolare facilmente il rapporto perfetto tra sale, zucchero, aceto e spezie per ogni possibile ortaggio sottaceto, in quantità che vanno da un singolo cetriolo solitario a base di ravanelli. I nostri collaboratori sono appassionati di sottaceti provenienti da tutto il mondo e i nostri utenti sono chef di casa, chef di ristoranti e persone che lavorano nel settore della logistica per grandi aziende e organizzazioni di trasformazione alimentare. Il nostro più grande utente è un'organizzazione che aiuta i banchi alimentari a trasformare le verdure a breve scadenza in barattoli stabili di sottaceti, aiutando le persone che hanno fame in molte comunità e riducendo gli sprechi alimentari. Inoltre, i nostri utenti ci inviano metriche facoltative relative all'utilizzo di Glorious Pickle, che utilizziamo per produrre il PickleSet, un grande set di dati per la creazione di nuove ricette di sottaceti tramite machine learning.
Informazioni sul progetto
Problema del tuo progetto
Descrivi il problema che il tuo progetto ti aiuterà 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 gli ingredienti di cucine non europee) allo strumento Glorious Pickle. Sfortunatamente, la procedura per aggiungere queste informazioni non è ben documentata, il che significa che i potenziali collaboratori devono segnalare un problema nel progetto per ricevere assistenza (o semplicemente rinunciare del tutto). Il processo presuppone inoltre che i collaboratori abbiano già familiarità con il nostro processo di richieste di pull e con GitHub, anche se molti dei nostri utenti non sono sviluppatori professionisti.
Più informazioni sugli ingredienti abbiamo, più Glorious Pickle è utile per tutti i nostri utenti.
L'ambito del tuo progetto
Indicaci quale documentazione creerà, aggiornerà o migliorerà la tua organizzazione. Se deliberatamente non vengono svolte alcune attività, includi anche queste informazioni. Includi una stima del tempo necessario e se hai già identificato volontari dell'organizzazione e un Technical Writer per il tuo progetto.
Il progetto Glorious Pickle (nome in codice PicklePlus):
- Controlla la documentazione esistente e crea un log di attrito della documentazione attuale per i tre casi d'uso principali (aggiunta di un nuovo ingrediente, aggiunta di una variante dell'ingrediente e aggiornamento o correzione delle informazioni su un ingrediente).
- Utilizzando il log di attrito come guida per comprendere le lacune nella documentazione, crea documentazione aggiornata per i casi d'uso principali.
- Crea una breve "scheda di riferimento" per aiutare i nuovi collaboratori a estrarre richieste e GitHub per aiutarli a utilizzare la nostra procedura.
- Incorpora il feedback dei tester della documentazione (volontari nel progetto) e della più ampia community di Glorious Pickle.
- Collabora con il team addetto al rilascio per aggiornare la documentazione sul sito Glorious Pickle e per creare un processo che consenta di mantenere sincronizzata la documentazione con lo strumento di aggiornamento in futuro.
Lavoro fuori dall'ambito di questo progetto:
- Questo progetto non creerà un processo per il crosslinking tra ortografie o nomi diversi per lo stesso ingrediente.
- Questo progetto non creerà tutorial GitHub. La scheda di riferimento rimanderà invece a materiali esistenti pertinenti e utili.
Abbiamo due validi candidati alla scrittura tecnica per questo progetto e prevediamo che il completamento di questo lavoro richiederà tre mesi. Il gruppo SIG Glorious Pickle PickleDocs e @Glorious PicklePat (il principale gestore dell'API per l'aggiunta degli ingredienti) si sono impegnati a supportare il progetto.
Misurare il successo del tuo progetto
Come farai a sapere che la nuova documentazione ti ha aiutato a risolvere il problema? Quali metriche userai e come li monitorerai?
Glorious Pickle riceve una media di dieci richieste di pull a trimestre per aggiungere o aggiornare nuovi ingredienti ('ingrediente' taggato). La maggior parte di queste richieste di pull (>60%) proviene da collaboratori precedenti. Riteniamo che questa documentazione migliorata si tradurrà in un maggior numero di richieste di pull e di richieste di pull da parte dei nuovi collaboratori. Poiché la maggior parte dei nostri collaboratori attivi ha iniziato aggiungendo ingredienti, riteniamo anche che il miglioramento di questa documentazione si tradurrà in collaboratori più attivi nel complesso.
Terremo traccia di due metriche (numero di richieste di pull relative agli ingredienti e numero di richieste di pull da parte di nuovi collaboratori) ogni mese dopo la pubblicazione della documentazione. Inoltre, terremo traccia del numero totale di collaboratori che hanno dato più di tre contributi, a partire da ogni trimestre dopo la pubblicazione della documentazione.
Riteniamo che il progetto sia efficace se, dopo la pubblicazione della nuova documentazione:
- Il numero di richieste di pull relative agli ingredienti aumenta del 20%
- Il numero di richieste di pull dai nuovi collaboratori aumenta del 15%
- Il numero di collaboratori che hanno fornito più di 3 contributi aumenta del 10% (a partire dal trimestre successivo alla pubblicazione della documentazione).
Sequenza
Quanto tempo prevedi che questo lavoro richiederà? Riesci a suddividere le attività degli autori di tecnologie per mese/settimana?
Il completamento del progetto richiederà circa sei mesi. Una volta assunto il responsabile della tecnologia, dedicheremo un mese all'orientamento come autore di tecnologie, quindi passeremo al log di controllo e degli errori e dedicheremo gli ultimi mesi alla creazione della documentazione.
| Date | Azioni |
|---|---|
| Maggio | Orientamento |
| Giugno - agosto | Controlla la documentazione esistente e crea log di attrito |
| Settembre - Ottobre | Crea documentazione |
| novembre | Completamento del progetto |
Budget del progetto
Linee guida generali
- Puoi includere il budget nella proposta o in un link separato. Se il budget è inferiore a dieci elementi, ti consigliamo di includerlo nella proposta.
- Tutti i budget devono essere espressi in dollari statunitensi. Prevediamo che le sovvenzioni siano comprese tra 5.000 e 15.000 $; se il tuo progetto non rientra in questo intervallo, fornisci ulteriori informazioni per giustificare il budget.
- Prevediamo che la maggior parte del tuo budget (minimo 60-70%) venga assegnata al Technical Writer che lavora al tuo progetto. Ti consigliamo di definire il budget in base al progetto, ove possibile.
- Ci aspettiamo che i progetti open source utilizzino strumenti open source quando possibile. Se il tuo progetto richiede assolutamente fondi per licenze software proprietari o assistenza, includi una giustificazione per l'importo.
- Altre possibili spese includono:
- Progettazione per la creazione di branding, loghi, modelli o altre risorse di design per il tuo sito di documentazione
- Importi minimi (< 200 $) per i gadget del progetto (t-shirt o adesivi per i partecipanti). Se utilizzi il logo Season of Docs, deve essere accompagnato dal logo o dal nome del tuo progetto o della tua organizzazione. Il gadget potrebbe non utilizzare il nome Google.
- Stipendi minimi per i volontari che ricoprono importanti ruoli di mentore o guida nel progetto (consigliamo non più di 500 $per volontario)
- Le donazioni a valle ad altri progetti open source non devono superare il 10% del budget totale.
- Se necessario, includi altre voci di budget, insieme alla giustificazione dell'importo richiesto. Le giustificazioni delle spese dovrebbero evidenziare in che modo la spesa contribuirà al successo del progetto nel suo complesso.
Esempio di budget
| Voce di budget | Importo | Totale corrente | Note/giustificazioni |
|---|---|---|---|
| Il Technical writer controlla, aggiorna, testa e pubblica nuova documentazione sul processo di aggiunta degli ingredienti per Glorious Pickle | 5000,00 | 5000,00 | |
| Stipendi di volontariato | 500 | 6500.00 | 3 borse di studio volontarie x 500 ciascuna |
| T-shirt Project (10 t-shirt) | 150.00 | 6650,00 | |
| Unicorno gonfiabile gigante (versione di 4,5 metri) | 99,99 | 6749,99 | Assegneremo l'unicorno gonfiabile al team che risponde alle domande del Technical Writer più velocemente durante il periodo di sviluppo del progetto |
| TOTALE | 6749,99 |
Informazioni aggiuntive
Includi qui qualsiasi informazione aggiuntiva pertinente alla tua proposta.
Esperienza con i Technical Writer o la documentazione: se tu o uno dei tuoi mentori avete già lavorato con i Technical Writer o avete sviluppato la documentazione, indicatelo nella vostra applicazione. Descrivi la documentazione che hai prodotto e le modalità in cui hai collaborato con il Technical Writer. Ad esempio, descrivi i processi di revisione che hai utilizzato o come le competenze del Technical Writer sono state utili per il tuo progetto. Spiega come questa esperienza precedente può aiutarti a lavorare con un Technical Writer in Season of Docs.
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, indicatelo nella domanda. Descrivi i tuoi risultati nel programma. Spiega come questa esperienza può influenzare il tuo modo di lavorare in Season of Docs.