Cette page contient les détails d'un projet de rédaction technique accepté pour Google Season of Docs.
Résumé du projet
- Organisation Open Source:
- Open Collective
- Rédacteur technique:
- Anna e só
- Nom du projet:
- Améliorer la documentation d'aide générale
- Durée du projet:
- Durée standard (3 mois)
Project description
Premières impressions Il est fréquent de tomber sur des pages de documentation contenant des instructions sans contenu multimédia (vidéos, GIF, images), tandis que les autres sections du même chapitre contiennent des entrées plus complètes. Par exemple, Edit Collective (Modifier l'organisation collective) est uniquement composé d'instructions, tandis que Add Fiscal Host (Ajouter un hôte fiscal) intègre des médias de soutien.
Dans les pages que j'ai parcourues, aucun support n'est décrit à l'aide de l'attribut texte alternatif. L'absence de descriptions d'images entrave une compréhension complète de la documentation pour les utilisateurs de lecteurs d'écran et les personnes dont la connexion Internet est lente, et donc que certains contenus multimédias ne peuvent pas se charger.
Certaines sections de la documentation fusionnent les questions fréquentes et les instructions directes sur la navigation dans l'interface utilisateur, telles que Changer d'hôte fiscal. Étant donné qu'il n'y a pas de table des matières dans l'interface de documentation, un utilisateur qui est au courant des conséquences d'une modification des enregistrements d'enregistrement et qui veut simplement des instructions objectives peut percevoir la documentation comme détaillée et trop tangentielle.
Bien que le langage de la documentation technique soit assez cohérent, le guide de style, accessible au public, documente trop peu la manière dont la documentation doit être rédigée. Étant donné que la page Contribuer mentionne les contributions à la documentation technique, Open Collective et les contributeurs potentiels bénéficieraient de consignes plus complètes.
Proposition Je propose de passer en revue les pages d'aide des utilisateurs, en repensant leur présentation et leur structure actuelle.
Méthodologie et calendrier Je souhaite améliorer la documentation Open Collective en travaillant avec la communauté en favorisant des cycles de commentaires continus de durée variable.
Période de cohésion de la communauté (du 1er août au 1er septembre 2019): découverte de la communauté Open Collective. Interroger des membres actifs issus de projets importants et en cours de développement, leur poser des questions sur l’état actuel de la documentation (rapport n° 1) Prise en compte de tous les systèmes internes utilisés pour suivre les requêtes et les problèmes, ainsi que du processus permettant de les documenter dans Open Collective Docs (rapport n° 2). Évaluation des problèmes latents dans la version actuelle de la documentation et préparation d'un plan pour les résoudre (rapport n° 3).
2-6 septembre: Premier cycle de rétroaction et d'ajustement, en tenant compte de tous les commentaires et suggestions faits par la communauté pendant la période de cohésion de la communauté. Notre plan est-il prévu ? Y a-t-il quelque chose qui doit changer ? (Rapport n° 4)
9 septembre et 20 septembre: élaboration d'une démonstration de faisabilité avec le chapitre moins renseigné de la documentation. Brouillon d'un guide de style public (rapport n° 5)
23-25 septembre: envoi d'une preuve de concept à des fins d'évaluation (groupe fermé).
26 et 27 septembre: des ajustements doivent-ils être apportés à notre démonstration de faisabilité avant la mise en ligne ? Besoin de plus de temps ? Ajustez-les en conséquence. (Rapport n° 6)
30 septembre – 9 octobre: mise en ligne de la démonstration de faisabilité. Deuxième cycle de commentaires (groupe public).
10-15 octobre: cycle final d'évaluation et d'ajustement de la démonstration de faisabilité (Rapport n° 7)
16 et 20 octobre: petite pause dans les activités [1].
Du 21 octobre au 23 novembre: version finale du guide de style public (rapport n° 8). Application de toutes les instructions présentes dans le guide de style à toutes les pages de documentation utilisateur (rapport n° 9). Rapport évaluant toutes les activités effectuées et recommandations supplémentaires pour la communauté (rapport n° 10)
La durée du projet peut être prolongée sur demande.
[1]: voyage planifié avant mon application Season of Docs.
Livrables - Dix rapports publics sur les activités réalisées - Guide de style public pouvant être utilisé par Open Collective et par les contributeurs externes - Refonte des pages de documentation utilisateur