Fase attuale:
Sviluppo della documentazione. Consulta la cronologia.
Utilizza questa guida come modello per creare la proposta di progetto della tua organizzazione.
PROPOSAL TITLE - nome dell'organizzazione
Il titolo della tua proposta deve essere breve e specifico. "Aggiorna la guida per i collaboratori di ORGNAME" è un buon titolo per la proposta. "Miglioramenti alla documentazione" è troppo vaga; la sezione "Aggiorna le sezioni 5,7,23,99 della Guida per i collaboratori, delle domande frequenti sulla creazione e della Guida di stile per la creazione" è troppo lunga.
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 i tuoi utenti e collaboratori? Da quanto tempo esiste la tua organizzazione o il tuo progetto? Fornisci del contesto per aiutarci a capire perché il finanziamento della tua proposta avrebbe un impatto positivo sull'open source e nel mondo.
Glorious Pickle (versione corrente 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 a forma di cucciolo solitario a carichi di ravanelli. I nostri collaboratori sono appassionati di sottaceti provenienti da tutto il mondo e i nostri utenti sono chef amatoriali, chef di ristoranti e persone che lavorano nella logistica per grandi aziende e organizzazioni di trasformazione alimentare. Il nostro principale utente è un'organizzazione che aiuta i banchi alimentari a trasformare le verdure a breve periodo in vasetti stabili di sottaceti, aiutando a nutrire le persone affamate di molte comunità e riducendo gli sprechi alimentari. Inoltre, i nostri utenti ci inviano metriche facoltative sull'utilizzo di Gloriouspickle, che utilizziamo per produrre il PickleSet, un grande set di dati per la creazione di nuove ricette di sottaceti attraverso il machine learning.
Informazioni sul progetto
Il problema del tuo progetto
Descrivi il problema che ti aiuterà a risolvere il tuo progetto. 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. Purtroppo, 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). Inoltre, il processo presuppone che i collaboratori abbiano già familiarità con il nostro processo di richiesta di pull e con GitHub, anche se molti dei nostri utenti non sono sviluppatori professionisti.
Più informazioni abbiamo sugli ingredienti, più Gloriouspickle sarà utile per tutti i nostri utenti.
L'ambito del tuo progetto
Indicaci quale documentazione verrà creata, aggiornata o migliore dalla tua organizzazione. Se deliberatamente alcune attività non vengono svolte, includi anche queste informazioni. Includi una stima del tempo e indica se hai già identificato volontari dell'organizzazione e un Technical Writer che lavorino al tuo progetto.
Il progetto Glorious Pickle (nome in codice PicklePlus) potrà:
- 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 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 principali casi d'uso.
- Crea una breve scheda di riferimento per aiutare i collaboratori nuovi a eseguire il pull delle richieste e GitHub per aiutarli a utilizzare il nostro processo.
- Includi il feedback dei tester della documentazione (volontari nel progetto) e della più ampia community Glorious Pickle.
- Collabora con il team addetto al rilascio per aggiornare la documentazione sul sito Gloriouspickle e per creare un processo che garantisca la sincronizzazione con lo strumento di aggiornamento in futuro.
Lavoro che non rientra nell'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 stimiamo che il completamento di questo lavoro richiederà tre mesi. Il Glorious Pickle PickleDocs SIG e @GloriousSelectlePat (il principale mantenimento dell'API per l'aggiunta degli ingredienti) si sono impegnati a supportare il progetto.
Valutazione del successo del progetto
Come fai a sapere che la nuova documentazione ha aiutato a risolvere il tuo problema? Quali metriche userai e come monitorerai?
Glorious Pickle riceve una media di dieci richieste di pull a trimestre per aggiungere o aggiornare nuovi ingredienti (tag "ingrediente"). 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 di 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.
Monitoreremo due metriche (numero di richieste di pull relative agli ingredienti e numero di richieste di pull da 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 andato a buon fine 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 da parte di 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 scrittori di tecnologia per mese o per settimana?
Il completamento del progetto richiederà circa sei mesi. Una volta assunto, dedichiamo un mese all'orientamento come scrittore tecnico, quindi passeremo all'audit e al log di attrito e passeremo gli ultimi mesi alla creazione della documentazione.
| Date | Azioni |
|---|---|
| Maggio | Orientamento |
| Giugno - agosto | Controlla la documentazione esistente e crea un log di attrito |
| Settembre - Ottobre | Crea documentazione |
| Novembre | Completamento del progetto |
Budget del progetto
Linee guida generali
- Puoi includere il budget nella proposta o sotto forma di link separato. Se il budget è inferiore a dieci elementi, ti consigliamo di includerlo nella proposta.
- Tutti i budget devono essere in dollari statunitensi. Prevediamo che le donazioni siano comprese tra 5000$e 15.000 $; se il tuo progetto non rientra in questo intervallo, fornisci informazioni aggiuntive 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, se 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 per l'assistenza, includi una giustificazione per l'importo.
- Altre possibili spese includono:
- Progetta un lavoro per creare branding, loghi, modelli o altre risorse di design per il tuo sito di documentazione
- Importi minimi (< $ 200) per gadget di progetto (t-shirt o adesivi per i partecipanti). Se utilizzi il logo della stagione di Google Documenti, deve essere accompagnato dal logo o dal nome del progetto o dell'organizzazione. Il gadget potrebbe non utilizzare il nome Google.
- Stipendi minimi per i volontari che svolgono un considerevole ruolo di tutoraggio o di orientamento nel progetto (consigliamo non più di 500 $per volontario, per favore)
- Le donazioni a valle di altri progetti open source non devono superare il 10% del budget totale.
- Se necessario, includi altre voci del budget, insieme alla giustificazione dell'importo richiesto. La giustificazione delle spese dovrebbe evidenziare come la spesa contribuirà al successo del progetto nel suo complesso.
Esempio di budget
| Voce del budget | Importo | Totale corrente | Note/giustificazioni |
|---|---|---|---|
| Il Technical writer esegue l'auditing, l'aggiornamento, il test e la pubblicazione della nuova documentazione del processo di aggiunta degli ingredienti per Glorious Pickle | 5000,00 | 5000,00 | |
| Stipendi per volontari | 500 | 6.500,00 | 3 borse di studio volontarie x 500 ciascuna |
| T-shirt Project (10) | 150,00 | 6650,00 | |
| Unicorno gonfiabile gigante (versione da 4,5 m) | 99,99 | 6749,99 | Daremo il modello unicorno gonfiabile al team che risponde alle domande del redattore tecnico il più velocemente possibile durante il periodo di sviluppo del progetto |
| TOTALE | 6749,99 |
Informazioni aggiuntive
Inserisci qui tutte le informazioni aggiuntive pertinenti alla tua proposta.
Precedente esperienza con i Technical writer o nella 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 writer tecnico. Ad esempio, descrivi le procedure di revisione che hai utilizzato o in che modo le competenze dello scrittore tecnico sono state utili per il tuo progetto. Spiega come questa esperienza precedente può aiutarti a collaborare con un Technical Writer in Google Season of Docs.
Partecipazione precedente a Google Season of Docs, Google Summer of Code o a altri: se tu o uno dei tuoi mentori avete partecipato al programma Google Summer of Code o a un programma simile, specificatelo nella domanda di partecipazione. Descrivi i tuoi risultati nel programma. Spiega come questa esperienza può influenzare il tuo modo di lavorare nella stagione di Documenti Google.