Phase actuelle:
Développement de la documentation. Consultez le calendrier.
Utilisez ces modèles de titres 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 Google Saison des documents de votre organisation)
Description de l'organisation: elevator pitch qui donne un bref aperçu de la mission de votre organisation ou de votre projet.
Auteurs: facultatif: listez les auteurs de l'étude de cas ; utilisez des noms d'utilisateur si demandé
Description du problème
Quel problème cherchiez-vous à résoudre avec de la nouvelle documentation ou de la documentation améliorée ?
Extrait de la proposition
Bref résumé de votre proposition initiale d'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 Google Season of Docs ? Quel processus votre organisation a-t-elle utilisé pour prendre une idée ? Comment avez-vous sollicité et intégré des commentaires ?
Budget
Incluez une courte partie de votre budget. Comment avez-vous estimé le travail ? Y a-t-il eu des dépenses imprévues ? Avez-vous finalement dépensé moins que le montant de la subvention ? Avez-vous alloué les fonds correctement ou votre budget était-il plus/moins/négatif pour certains éléments ? Disposez-vous d'autres fonds en dehors de Google Season of Docs que vous pouviez utiliser ?
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 ? Est-ce que quelqu'un a abandonné ? Qu'avez-vous appris sur le recrutement, la communication et la gestion de projet ?
Chronologie
Présentez brièvement le 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 devait-il ê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. Y avait-il des produits livrables dans la proposition qui n'ont pas été créés ? Listez-les également. Ce projet a-t-il entraîné des processus ou des procédures nouveaux ou mis à jour dans votre organisation ?
Métriques
Quelles métriques avez-vous choisies pour mesurer la réussite du projet ? Avez-vous pu collecter ces métriques ? Les métriques concordent-elles bien ou mal avec les comportements ou les 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 prévoyez-vous de collecter des métriques à l'avenir ?
Analyse
Qu'est-ce qui s'est bien passé ? Quels sont les résultats inattendus ? Quels obstacles ou difficultés avez-vous rencontrés ? Pensez-vous que votre projet est réussi ? Pourquoi ? (S'il est trop tôt pour le dire, expliquez à quel moment vous pensez pouvoir juger de la réussite de votre projet.)
Résumé
Résumez en deux ou quatre paragraphes votre expérience du projet. 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 essaient de résoudre un problème similaire avec la documentation ?
Annexe
Si vous souhaitez créer un lien vers d'autres documents (par exemple, si vous avez créé un contrat de travail avec votre rédacteur technique et que vous souhaitez le partager, des modèles pour votre projet de documentation ou d'autres ressources de documentation ouvertes, vous pouvez les répertorier et les lier ici). L'annexe est également un bon endroit pour répertorier des liens vers les outils ou ressources de documentation que vous avez utilisés, ou pour exprimer des remerciements ou des remerciements qui pourraient ne pas correspondre aux sections ci-dessus.