Créer une étude de cas

Phase actuelle:
Le programme Season of Docs 2021 s'est terminé le 14 décembre 2021. Consultez la chronologie.

Pour la saison 2021 de Docs, les organisations sont tenues de soumettre une évaluation finale et une étude de cas. Utilisez notre modèle d'étude de cas et notre exemple d'étude de cas comme guides pour créer votre propre étude de cas de projet.

Le formulaire d'évaluation finale sera disponible au moins un mois avant le 30 novembre 2021 à 18h UTC.

Présentation de l’étude de cas

Le modèle d'étude de cas comprendra les sections suivantes:

  • Énoncé de problème: quel problème tentiez-vous de résoudre avec une documentation nouvelle ou améliorée ?
  • Extrait de la proposition: bref résumé de la proposition d'origine de l'organisation
  • Description du projet: une description narrative de votre projet. Incluez les éléments suivants :
    • La façon dont vous avez créé votre proposition (et un lien vers la page des idées de projet d'origine).
    • La façon dont vous avez recruté et sélectionné un rédacteur technique ou d'autres participants.
    • Qui a travaillé sur le projet (utilisez les noms d'utilisateur si les participants le demandent).
    • Combien de temps le projet a-t-il duré (s’il est terminé).
    • Qu'est-ce qui s'est bien passé ?
    • Qu'est-ce qui était inattendu ? Quels obstacles ou difficultés avez-vous rencontrés ?
    • Quelle documentation a été créée, mise à jour, améliorée ou supprimée ?
  • Ce projet a-t-il entraîné des processus ou des procédures nouveaux ou mis à jour dans votre organisation ?
  • Métriques :
    • Quelles mesures ont été choisies pour mesurer le succès du projet ?
    • Avez-vous pu collecter ces métriques ?
    • Sont-ils corrélés aux comportements ou aux benchmarks que vous attendiez ?
    • Les métriques que vous avez choisies ont-elles changé ? Avez-vous supprimé ou ajouté des métriques ?
    • D'après vos indicateurs, votre projet est-il réussi ? (Il est peut-être trop tôt pour le dire.)
    • À quelle fréquence avez-vous l'intention de collecter des métriques ?
  • Résumé :
    • En 2 à 4 paragraphes, résumez votre expérience du projet. Qu'avez-vous appris ? Que feriez-vous différemment à l'avenir ? Quel conseil donneriez-vous aux projets qui essaient de résoudre un problème similaire avec la documentation ?

Conseils sur les études de cas

  • Tenir un journal hebdomadaire des mises à jour du projet vous aidera à créer votre étude de cas. Pour chaque semaine, enregistrez l'avancement du projet (y compris les liens vers les demandes d'extraction, les problèmes ou les conversations, le cas échéant), ce qui s'est bien (ou pas) bien, ce que vous avez appris et les questions qui ont été posées.
  • Lorsque vous rédigez votre étude de cas, soyez gentil. Évitez les reproches et restez constructif. N'oubliez pas que les études de cas sont publiques !
  • Dans votre étude de cas, utilisez le même ton que pour un article de blog ou un tutoriel. Ne soyez pas trop formel.