Fase attuale:
Il programma Stagione di Documenti 2021 si è concluso il 14 dicembre 2021. Consulta la cronologia.
Utilizza queste intestazioni dei modelli per creare il tuo report sul case study.
Titolo
Organizzazione o progetto: nome organizzazione (link alla pagina o al sito della stagione dei documenti dell'organizzazione)
Descrizione dell'organizzazione: unelevator pitch che offre una breve panoramica di ciò che fa la tua organizzazione o il 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 del progetto
Creare la proposta
Come è nata la tua proposta per la stagione di Documenti? Quale processo ha utilizzato la tua organizzazione per prendere decisioni in merito a 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? Hai speso meno del premio per la donazione? Avevi altri fondi oltre alla Season of Docs 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 ha svolto? Qualcuno ha abbandonato? 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 dei risultati finali 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 sono correlate in modo soddisfacente o insoddisfacente ai risultati auspicati per il progetto? Le metriche sono cambiate dopo la proposta?
Analisi
Cosa ha funzionato? Che cosa non era previsto? Quali ostacoli o difficoltà hai dovuto affrontare? Ritieni che il tuo progetto sia efficace? Perché o perché no? Se è troppo presto per dirlo, spiegagli quando pensi di poter valutare il successo del tuo progetto.
Riepilogo
In 2-4 paragrafi, riassumi la tua esperienza relativa al progetto. Metti in evidenza ciò che hai imparato e cosa sceglieresti di fare in modo diverso in futuro. Che consiglio daresti ad altri progetti che cercano di risolvere un problema simile con la documentazione?
Appendice
Se vuoi aggiungere link ad altri materiali, ad esempio se hai creato un contratto per collaborare con il tuo Technical Writer che vuoi condividere, oppure modelli per il tuo 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 qualsiasi strumento o risorsa di documentazione che hai utilizzato o un punto in cui aggiungere ringraziamenti o ringraziamenti che potrebbero non rientrare nelle sezioni precedenti.