Creare un case study

Fase attuale:
Il programma per la stagione di Documenti 2021 è terminato il 14 dicembre 2021. Consulta la cronologia.

Nell'ambito della stagione dei documenti 2021, le organizzazioni sono tenute a inviare una valutazione finale e un case study. Utilizza il modello di case study e il case study di esempio come guide per creare il case study per il tuo progetto.

Il modulo di valutazione finale sarà disponibile almeno un mese prima delle 18:00 UTC del 30 novembre 2021.

Panoramica del case study

Il modello del case study includerà le seguenti sezioni:

  • Dichiarazione del problema: quale problema stavi cercando di risolvere con una documentazione nuova o migliorata?
  • Estratto della proposta: un breve riepilogo della proposta originale per l'organizzazione
  • Descrizione del progetto: una descrizione narrativa del tuo progetto. Includi:
    • Il modo in cui hai creato la proposta (e link alla pagina originale delle idee per il progetto).
    • Il modo in cui hai reclutato e selezionato un Technical Writer o altri partecipanti.
    • Chi ha lavorato al progetto (utilizza i nomi utente se richiesto dai partecipanti).
    • Il tempo necessario per il completamento del progetto (se completato).
    • Che cosa è andato bene?
    • Che cosa non era previsto? Quali ostacoli o difficoltà hai dovuto affrontare?
    • Quale documentazione è stata creata, aggiornata, migliorata o rimossa?
  • Questo progetto ha comportato processi o procedure nuovi o aggiornati nella tua organizzazione?
  • Metriche:
    • Quali metriche sono state scelte per misurare il successo del progetto?
    • Hai potuto raccogliere queste metriche?
    • Sono correlati ai comportamenti o ai benchmark che ti aspettavi?
    • Le metriche che hai scelto sono cambiate? Hai rimosso o aggiunto delle metriche?
    • In base alle metriche, il tuo progetto ha successo? (Potrebbe essere troppo presto per dirlo.)
    • Con quale frequenza intendi raccogliere metriche in futuro?
  • Riepilogo:
    • Descrivi in 2-4 paragrafi la tua esperienza con il progetto. Che cosa hai imparato? Che cosa faresti di diverso in futuro? Quale consiglio daresti ai progetti che cercano di risolvere un problema simile con la documentazione?

Indicazioni per i case study

  • Tenere un diario settimanale degli aggiornamenti del progetto ti aiuterà a creare il tuo case study. Per ogni settimana, registra l'avanzamento del progetto (inclusi link a richieste di pull, problemi o conversazioni, se utili), ciò che è andato bene (o meno bene), ciò che hai imparato e le domande che sono state poste.
  • Quando scrivi il case study, sii gentile. Evita i colpevoli e mantieni un approccio costruttivo. Ricorda che i case study sono pubblici.
  • Nel case study, usa lo stesso tono che useresti per un post del blog o un tutorial; non essere eccessivamente formale.