Fase attuale:
il programma della Stagione dei documenti 2021 è terminato il 14 dicembre 2021. Visualizza
sequenza temporale.
Utilizza queste intestazioni del modello per creare il tuo report del case study.
Titolo
Organizzazione o progetto: nome dell'organizzazione (link alla pagina o al sito della stagione dei documenti della tua organizzazione)
Descrizione dell'organizzazione: un breve presentazione che presenta una breve panoramica delle attività svolte dalla tua organizzazione o dal 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 la 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 del progetto
Creazione della proposta
Come hai ideato la tua proposta per la Stagione dei documenti? 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 potuto utilizzare altri fondi al di fuori della Stagione dei documenti?
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 le tappe intermedie se il progetto è in corso).
Risultati
Che cosa è stato creato, aggiornato o modificato in altro modo? Includi i link alla documentazione pubblicata, se disponibili. Ci sono elementi della proposta che non sono stati creati? Elenca anche queste.
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 risultati che volevi ottenere per il progetto? Le tue metriche sono cambiate dalla tua proposta?
Analisi
Che cosa ha funzionato? Cosa non era previsto? Quali ostacoli hai dovuto affrontare? Ritieni che il tuo progetto abbia successo? Qual è il motivo? Se è troppo presto per dirlo, spiega quando prevedi di poter giudicare 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 stanno cercando 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 punto per elencare i link a eventuali strumenti di documentazione o risorse che hai utilizzato, nonché per aggiungere ringraziamenti o ringraziamenti che potrebbero non rientrare nelle sezioni precedenti.