Creare un case study

Fase attuale:
Il programma Stagione di Documenti 2021 si è concluso 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 nostro modello di case study e il case study di esempio come guide per creare il case study del tuo progetto.

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

Panoramica del case study

Il modello di case study includerà le seguenti sezioni:

  • Dichiarazione del problema: quale problema stavi cercando di risolvere con la documentazione nuova o migliorata?
  • Riepilogo della proposta: un breve riepilogo della proposta originale dell'organizzazione
  • Descrizione del progetto: una descrizione narrativa del progetto. Includi:
    • Come hai creato la proposta (e il link alla pagina delle idee di progetto originali).
    • In che modo hai reclutato e selezionato un autore tecnico o altri partecipanti.
    • Chi ha lavorato al progetto (utilizza i nomi utente se richiesto dai partecipanti).
    • Il tempo necessario per completare il progetto (se completato).
    • Cosa ha funzionato
    • Cosa non era previsto? Quali ostacoli o battute d'arresto hai incontrato?
    • Quale documentazione è stata creata, aggiornata, migliorata o rimossa?
  • Questo progetto ha generato procedure o processi nuovi o aggiornati nella tua organizzazione?
  • Metriche:
    • Quali metriche sono state scelte per misurare il successo del progetto?
    • Hai potuto raccogliere queste metriche?
    • Sono stati correlati ai comportamenti o ai benchmark che ti aspettavi?
    • Le metriche che hai scelto sono cambiate? Hai rimosso o aggiunto metriche?
    • Secondo le tue metriche, il tuo progetto è efficace? Potrebbe essere troppo presto per dirlo.
    • Con quale frequenza intendi raccogliere metriche in futuro?
  • Riepilogo:
    • Riepiloga la tua esperienza con il progetto in 2-4 paragrafi. Cosa hai imparato? Cosa faresti di diverso in futuro? Che consiglio daresti ai progetti che stanno cercando di risolvere un problema simile con la documentazione?

Informazioni sui case study

  • Tenere un log settimanale degli aggiornamenti del progetto ti aiuterà a creare il tuo case study. Per ogni settimana, registra l'avanzamento del progetto (inclusi i link a richieste pull, problemi o conversazioni, se utili), cosa è andato bene (o male), cosa hai imparato e le domande che ti sono state poste.
  • Quando scrivi il case study, sii gentile. Evita di dare la colpa e mantieni un atteggiamento costruttivo. Ricorda che i case study sono pubblici.
  • Utilizza lo stesso tono nel tuo case study che per un post del blog o un tutorial. Non essere eccessivamente formale.