Phase actuelle:
Le programme Season of Docs 2021 s'est terminé le 14 décembre 2021. Voir la chronologie.
Utilisez ces titres de modèle pour vous aider à créer votre propre rapport d'étude de cas.
Titre
Organisation ou projet: Nom de l'organisation (lien vers la page ou le site de la Saison des documents de votre organisation)
Description de l'organisation: pitch qui donne un bref aperçu de l'activité de votre organisation ou de votre projet.
Auteurs: facultatif: listez les auteurs de l'étude de cas ; utilisez des noms d'utilisateur si nécessaire
Description 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 votre proposition d'organisation initiale. Si possible, ajoutez un lien vers la page de la proposition sur le site de votre projet.
Description du projet
Créer la proposition
Comment avez-vous élaboré votre proposition pour la saison des documentations ? Quel processus votre organisation a-t-elle suivi pour choisir une idée ? Comment avez-vous recueilli et intégré les commentaires ?
Budget
Incluez une courte section sur votre budget. Comment avez-vous estimé le travail ? Y a-t-il eu des dépenses imprévues ? Avez-vous dépensé moins que le montant de la subvention ? Avez-vous pu utiliser d'autres fonds en dehors de la saison des documents ?
Participants
Qui a travaillé sur ce projet (utilisez les noms d'utilisateur si les participants le demandent) ? Comment avez-vous trouvé et embauché votre rédacteur technique ? Comment avez-vous trouvé d'autres bénévoles ou participants rémunérés ? Quels étaient leurs rôles ? Quelqu'un a-t-il abandonné ? Qu'avez-vous appris sur le recrutement, la communication et la gestion de projet ?
Chronologie
Donnez un bref aperçu du calendrier de votre projet (indiquez la date de fin estimée ou les étapes intermédiaires si le projet est en cours).
Résultats
Qu'est-ce qui a été créé, mis à jour ou modifié ? Incluez des liens vers la documentation publiée, le cas échéant. Y a-t-il des livrables de la proposition qui n'ont pas été créés ? Indiquez-les également.
Métriques
Quelles métriques avez-vous choisies pour mesurer le succès du projet ? Avez-vous réussi à collecter ces métriques ? Les métriques ont-elles bien ou mal corrélé avec les résultats que vous souhaitiez obtenir pour le projet ? Vos métriques ont-elles changé depuis votre proposition ?
Analyse
Qu'est-ce qui a bien fonctionné ? À quoi ne vous attendiez-vous pas ? Quels obstacles ou revers avez-vous rencontrés ? Considérez-vous votre projet comme un succès ? Pourquoi ? (Si c'est trop tôt pour le dire, expliquez quand vous pourrez juger de la réussite de votre projet.)
Résumé
Résumez votre expérience de projet en deux à quatre paragraphes. Mettez en avant ce que vous avez appris et ce que vous choisiriez de faire différemment à l'avenir. Quels conseils donneriez-vous à d'autres projets qui tentent de résoudre un problème similaire avec la documentation ?
Annexe
Si vous souhaitez ajouter des liens vers d'autres documents (par exemple, si vous avez créé un contrat de collaboration avec votre rédacteur technique que vous souhaitez partager, ou des modèles pour votre projet de documentation, ou d'autres ressources de documentation ouvertes, vous pouvez les lister et les associer ici). L'annexe est également un bon endroit pour lister les liens vers les outils ou ressources de documentation que vous avez utilisés, ou pour ajouter des remerciements ou des remerciements qui ne peuvent pas figurer dans les sections ci-dessus.