Créer une étude de cas

Phase actuelle:
La saison 2021 du programme Docs s'est terminée le 14 décembre 2021. Voir la chronologie.

Dans le cadre de la saison des documents 2021, les organisations doivent envoyer une évaluation et une étude de cas finales. Utilisez notre modèle d'étude de cas et notre exemple d'étude de cas comme guides pour créer l'étude de cas de votre 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 comprend les sections suivantes:

  • Énoncé du problème: quel problème essayiez-vous de résoudre avec une nouvelle documentation ou une documentation améliorée ?
  • Résumé de la proposition: bref résumé de la proposition initiale de l'organisation
  • Description du projet: description narrative de votre projet. Incluez :
    • Comment vous avez créé votre proposition (et lien vers la page d'idées de projets d'origine).
    • Comment 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 a bien fonctionné ?
    • À quoi ne vous attendiez-vous pas ? Quels obstacles ou revers 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é de nouveaux processus ou procédures dans votre organisation ?
  • Métriques :
    • Quelles métriques ont été choisies pour mesurer le succès du projet ?
    • Avez-vous réussi à collecter ces métriques ?
    • Sont-elles corrélées 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 ?
    • Selon vos métriques, votre projet est-il un succès ? (Il est peut-être trop tôt pour le dire.)
    • À quelle fréquence comptez-vous recueillir des métriques à l'avenir ?
  • Résumé :
    • Résumez votre expérience de projet en deux à quatre paragraphes. Qu'avez-vous appris ? Que feriez-vous différemment à l'avenir ? Quel conseil donneriez-vous aux projets qui tentent de résoudre un problème similaire avec la documentation ?

Conseils pour les études de cas

  • Tenir un journal hebdomadaire des mises à jour du projet vous aidera à créer votre étude de cas. Chaque semaine, enregistrez la progression 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 passé (ou pas), ce que vous avez appris et les questions qui ont été posées.
  • Lorsque vous rédigez votre étude de cas, soyez bienveillant. Évitez de blâmer votre interlocuteur et restez constructif. N'oubliez pas que les études de cas sont publiques.
  • Utilisez le même ton dans votre étude de cas que dans un article de blog ou un tutoriel. N'ayez pas un ton trop formel.