Modello di case study di Google Season of Docs

Fase attuale:
Risultati annunciati. Consulta la cronologia.

Utilizza queste intestazioni del modello per creare il tuo report di case study.

Titolo

Organizzazione o progetto: nome dell'organizzazione (link alla pagina o al sito della stagione dei documenti Google della tua organizzazione)

Descrizione dell'organizzazione: un elevator pitch che offre una breve panoramica di cosa fa la tua organizzazione o il tuo progetto.

Authors: facoltativo: elenca gli autori del case study; utilizza i nomi utente se richiesti

Dichiarazione del problema

Quale problema stavi cercando di risolvere con una documentazione nuova o migliorata?

Estratto della proposta

Un breve riepilogo della proposta di organizzazione originale. Se possibile, includi un link alla pagina della proposta sul sito del progetto.

Descrizione progetto

Creazione della proposta

Come hai ideato la tua proposta per la Stagione dei documenti di Google? Quale procedura ha utilizzato la tua organizzazione per decidere su un'idea? Come hai richiesto e incorporato il feedback?

Budget

Includi una breve sezione sul budget. Come hai stimato il lavoro? Ci sono state spese impreviste? Hai speso meno del valore del contributo? Hai stanziato i fondi correttamente oppure alcuni degli elementi che avevi preventivato erano più/meno/non necessari? Avevi altri fondi al di fuori della stagione dei documenti di Google che hai potuto utilizzare?

Partecipanti

Chi ha lavorato a questo progetto (utilizza i nomi utente se richiesto dai partecipanti)? Come hai trovato e assunto il tuo autore tecnico? Come hai trovato altri volontari o partecipanti a pagamento? Quali ruoli ricopriva? Qualcuno ha abbandonato il gioco? Cosa hai imparato su reclutamento, comunicazione e gestione dei progetti?

Cronologia

Fornisci una breve panoramica della sequenza temporale del progetto (indica la data di fine stimata o i traguardi intermedi se il progetto è in corso).La sequenza temporale originale ha richiesto modifiche?

Risultati

Che cosa è stato creato, aggiornato o modificato in altro modo? Includi i link alla documentazione pubblicata, se disponibile. La proposta includeva alcuni prodotti finali che non sono stati creati? Elenca anche queste. Questo progetto ha comportato l'introduzione di procedure o processi nuovi o aggiornati nella tua organizzazione?

Metriche

Quali metriche hai scelto per misurare il successo del progetto? Hai potuto raccogliere queste metriche? Le metriche hanno mostrato una buona o scarsa correlazione con i comportamenti o i risultati che volevi ottenere per il progetto? Le tue metriche sono cambiate dalla tua proposta? Hai aggiunto o rimosso metriche? Con quale frequenza intendi raccogliere le metriche in futuro?

Analisi

Che cosa ha funzionato? Cosa non ti aspettava? Quali ostacoli hai dovuto affrontare? Consideri il tuo progetto un successo? Qual è il motivo? (se è troppo presto per dirlo, spiega quando pensi di poter valutare il successo del tuo progetto).

Riepilogo

Riassumi la tua esperienza con il progetto in 2-4 paragrafi. Metti in evidenza ciò che hai imparato e cosa sceglieresti di fare in modo diverso in futuro. Che consiglio daresti ad altri progetti che tentano di risolvere un problema simile con la documentazione?

Appendice

Se hai altri materiali da collegare (ad esempio, se vuoi condividere un contratto per collaborare con il tuo Technical Writer), oppure modelli per il progetto di documentazione o altre risorse di documentazione aperte, puoi elencarli e collegarli qui. L'appendice è anche un buon posto per elencare i link a eventuali strumenti o risorse di documentazione che hai utilizzato oppure per aggiungere ringraziamenti o riconoscimenti che potrebbero non rientrare nelle sezioni precedenti.