Fase attuale:
Il programma per la stagione di Documenti 2021 è terminato il 14 dicembre 2021. Consulta la cronologia.
Utilizza queste intestazioni del modello per creare il tuo report sul case study.
Titolo
Organizzazione o progetto: nome organizzazione (link alla pagina o al sito della stagione dei documenti della tua organizzazione)
Descrizione dell'organizzazione: una presentazione breve che offre una breve panoramica dello scopo della tua organizzazione o del tuo progetto.
Autori: facoltativo: elenca gli autori del case study; utilizza i nomi utente se richiesto
Dichiarazione del problema
Quale problema stavi cercando di risolvere con una documentazione nuova o migliorata?
Estratto della proposta
Un breve riepilogo della tua proposta originale per l'organizzazione. Se possibile, inserisci un link alla pagina della proposta sul sito del tuo progetto.
Descrizione progetto
Creare la proposta
Come hai elaborato la tua proposta per la stagione di Documenti? Quale processo ha utilizzato la tua organizzazione per decidere su un'idea? Come hai richiesto e incorporato il feedback?
Budget
Includi una breve sezione sul tuo budget. Come hai valutato il lavoro? Ci sono state spese impreviste? Alla fine, hai speso meno del premio per la concessione di una concessione? Avevi altri fondi oltre alla stagione dei documenti che hai potuto utilizzare?
Partecipanti
Chi ha lavorato a questo progetto (utilizza i nomi utente se richiesti dai partecipanti)? Come hai trovato e assunto il tuo Technical Writer? Come hai trovato altri volontari o partecipanti paganti? Quali ruoli hanno avuto? Qualcuno ha abbandonato il sito? Che cosa hai imparato su reclutamento, comunicazione e gestione dei progetti?
Sequenza
Fornisci una breve panoramica delle tempistiche del progetto (indica la data di fine stimata o gli obiettivi intermedi se il progetto è in corso).
Risultati
Che cosa è stato creato, aggiornato o modificato in altro modo? Includi i link alla documentazione pubblicata, se disponibile. La proposta conteneva risultati finali che non sono stati creati? Elenca anche queste informazioni.
Metriche
Quali metriche hai scelto per misurare il successo del progetto? Hai potuto raccogliere queste metriche? Le metriche sono correlate in modo soddisfacente o insoddisfacente ai risultati auspicati per il progetto? Le metriche sono cambiate dalla tua proposta?
Analisi
Cosa è andato bene? Che cosa non era previsto? Quali ostacoli o difficoltà hai dovuto affrontare? Ritieni che il tuo progetto sia riuscito? Perché o perché no? (Se è troppo presto per dirlo, spiegagli quando ti aspetti di poter giudicare il successo del progetto.)
Riepilogo
Descrivi in 2-4 paragrafi la tua esperienza con il progetto. Metti in evidenza ciò che hai imparato e cosa sceglieresti di fare in modo diverso in futuro. Quale consiglio daresti ad altri progetti che cercano di risolvere un problema simile con la documentazione?
Appendice
Se hai altri materiali a cui vuoi collegarti (ad esempio, se hai creato un contratto per lavorare con il tuo Technical Writer che vuoi condividere, modelli per il tuo progetto di documentazione o altre risorse di documentazione aperte, puoi elencarli e collegarli qui). Inoltre, l'Appendice è utile per elencare i link a eventuali risorse o strumenti di documentazione che hai utilizzato oppure in cui aggiungere ringraziamenti o ringraziamenti che potrebbero non rientrare nelle sezioni precedenti.