<Nom de l'organisation>: <Année> Étude de cas sur la saison de Google Docs
Nom de l'organisation ou du projet:
Lien Season of Docs:
Description de l'organisation: pitch d'une à deux phrases qui donne un bref aperçu de l'activité de votre organisation ou de votre projet.
Auteurs: listez les auteurs de l'étude de cas. Utilisez des noms d'utilisateur si vous le souhaitez (facultatif)
Résumé
Complétez le tableau suivant et fournissez des réponses brèves aux questions. Vous pourrez fournir plus de détails dans les sections suivantes. Nous vous recommandons de rédiger d'abord les sections détaillées, puis de revenir pour rédiger le résumé.
# Tech Writers | Heures de projet TW | Budget | % du projet terminé |
---|---|---|---|
## | ## | X $ | X % |
Quel problème essayiez-vous de résoudre ? Et comment avez-vous essayé de le résoudre ?
Quels ont été les résultats de votre projet ?
Qu'est-ce qui a bien fonctionné ? Que feriez-vous différemment ?
Quels conseils donneriez-vous à d'autres projets qui tentent de résoudre un problème similaire avec la documentation ?
Description du projet
Décrivez le projet en remplissant les sections suivantes.
Proposition de projet
Fournissez un bref résumé de votre proposition et un lien vers la page de la proposition sur le site de votre projet.
Processus de création de proposition
Comment avez-vous élaboré votre proposition pour la Google Season of Docs ? Quel processus votre organisation a-t-elle suivi pour prendre une décision ? Comment avez-vous sollicité et intégré les commentaires ? Qui a participé au processus ? Combien de temps cela a-t-il pris ?
Budget
Répondez aux questions du tableau suivant.
Combien d'argent avez-vous demandé ? | |
Comment avez-vous obtenu cette estimation ? | |
Combien d'heures de travail avez-vous budgétées pour le projet ? | |
Combien d'heures de travail ont été nécessaires pour le projet ? | |
Quelles autres dépenses avez-vous incluses dans votre budget ? | |
Avez-vous rencontré des surprises budgétaires au cours du projet (par exemple, des estimations incorrectes) ? Si oui, veuillez préciser. |
Recrutement d'un rédacteur technique
Comment avez-vous trouvé et embauché votre rédacteur technique ? Le processus a-t-il bien fonctionné ? Sont-ils restés pendant toute la durée du projet ?
Autres participants
Qui d'autre a travaillé sur ce projet (utilisez les noms d'utilisateur si les participants le demandent) ? Comment les avez-vous recrutés ? Quels étaient leurs rôles ? Est-il resté pendant toute la durée du 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é ?
Livrables
Complétez les tableaux suivants pour décrire ce qui a été créé, mis à jour ou modifié au cours du projet. Incluez les livrables planifiés et non planifiés. Veillez à inclure les éléments qui étaient prévus, mais qui n'ont pas été réalisés.
Livrables prévus
Les liens pertinents peuvent inclure des documents publiés, des demandes de tirage ou d'autres artefacts.
Livrable | % terminé | Liens associés | Remarques |
---|---|---|---|
Livrable 1 | |||
… | |||
Élément livrable N |
Contenus livrables non planifiés
Des livrables ont-ils été créés qui n'étaient pas prévus au début du projet ? Si oui, veuillez préciser.
Métriques
Quelles métriques avez-vous choisies pour mesurer le succès du projet ? Avez-vous pu collecter ces métriques ? Avez-vous constaté un changement à la suite du projet ? Avez-vous ajouté ou supprimé des métriques depuis votre proposition ? À quelle fréquence prévoyez-vous de collecter des métriques à l'avenir ?
Analyse
Fournissez un bref récit sur le déroulement du projet. Le projet a-t-il été un succès ? Pourquoi ? Ou quand pourrez-vous juger de son succès ? Avez-vous rencontré des obstacles ou des revers inattendus ? Le projet a-t-il entraîné de nouveaux processus ou procédures dans votre organisation ?
Enseignements à tirer
Utilisez les tableaux suivants pour mettre en avant les enseignements tirés : ce qui s'est bien passé et ce qui pourrait être amélioré. Utilisez les catégories de sujets listées si nécessaire ou ajoutez les vôtres. N'hésitez pas à ajouter plusieurs lignes pour un sujet donné si nécessaire. Ces enseignements seront intégrés à notre liste globale des bonnes pratiques pour les projets de documentation.
Qu'est-ce qui a bien fonctionné ?
Pour les enseignements tirés, ajoutez les vôtres ou indiquez un "plus un" pour l'une des bonnes pratiques existantes de la Google Season of Docs.
Thème | Notre stratégie | Leçons apprises |
---|---|---|
Budget | ||
Communication | ||
Parrainage | ||
Métriques | ||
Intégration | ||
Participants | ||
Produits livrables du projet | ||
Gestion de projets | ||
Recrutement et embauche | ||
… | ||
<Other Topics as Needed> | ||
Que pourrions-nous améliorer ?
Pour les enseignements tirés, ajoutez les vôtres ou indiquez un "plus un" pour l'une des bonnes pratiques existantes de la Google Season of Docs.
Thème | Notre stratégie | Ce que nous ferions différemment | Leçons apprises |
---|---|---|---|
Budget | |||
Communication | |||
Parrainage | |||
Métriques | |||
Intégration | |||
Participants | |||
Produits livrables du projet | |||
Gestion de projets | |||
Recrutement et embauche | |||
… | |||
<Other Topics as Needed> | |||
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 précédentes.