Modèle d'étude de cas Google Season of Docs

Phase actuelle:
Résultats annoncés. 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 "Saison des documents Google" 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: lister les auteurs de l'étude de cas ; utiliser des noms d'utilisateur si demandé

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 la proposition initiale de votre organisation. Si possible, ajoutez un lien vers la page de la proposition sur le site de votre projet.

Description du projet

Création de la proposition

Comment avez-vous élaboré votre proposition pour la Google Season of Docs ? Quel processus votre organisation a-t-elle utilisé 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 alloué les fonds correctement ? Certains éléments de votre budget étaient-ils trop élevés, trop faibles ou inutiles ? Avez-vous pu utiliser d'autres fonds en dehors de la saison Google pour les 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 rôles avaient-ils occupés ? 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 jalons intermédiaires si le projet est en cours).Le calendrier d'origine a-t-il dû être ajusté ?

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. La proposition comportait-elle des produits livrables qui n'ont pas été créés ? Indiquez-les également. Ce projet a-t-il entraîné la création ou la mise à jour de processus ou de procédures dans votre organisation ?

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 étaient-elles bien ou mal corrélées aux comportements ou aux résultats que vous vouliez pour le projet ? Vos métriques ont-elles changé depuis votre proposition ? Avez-vous ajouté ou supprimé des métriques ? À quelle fréquence comptez-vous collecter des métriques à l'avenir ?

Analyse

Qu'est-ce qui a bien fonctionné ? Qu'est-ce qui était inattendu ? 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. Quel conseil 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.