Cette page contient les détails d'un projet de rédaction technique accepté pour la 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 (trois mois)
Project description
Premières impressionsIl est courant de trouver des pages de documentation contenant des instructions sans supports multimédias (vidéos, GIF, images), tandis que d'autres sections du même chapitre comportent des entrées plus complètes. Par exemple, Modifier une collection ne contient que des instructions, tandis que Ajouter un hôte fiscal intègre des supports multimédias.
Sur les pages que j'ai consultées, aucun contenu multimédia n'est décrit à l'aide de l'attribut texte alternatif. L'absence de descriptions d'images empêche une compréhension complète de la documentation pour les personnes qui utilisent des lecteurs d'écran et celles dont la connexion Internet est lente, ce qui peut entraîner l'échec du chargement de tout élément multimédia.
Certaines sections de la documentation fusionnent des questions fréquentes et des instructions directes pour naviguer dans l'interface utilisateur, comme Modifier l'hôte fiscal. Étant donné qu'il n'y a pas de table des matières dans l'interface de documentation, un utilisateur qui connaît les conséquences d'une modification des enregistrements d'enregistrement et souhaite simplement obtenir des instructions objectives peut percevoir la documentation comme détaillée et trop tangente.
Bien que le langage de la documentation technique soit assez cohérent, le guide de style accessible au public ne donne pas suffisamment d'informations sur la façon 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é pour promouvoir des cycles de commentaires continus de durée variable.
Période de consolidation de la communauté (1er août au 1er septembre 2019): découvrez la communauté Open Collective ! Interroger des membres actifs de projets importants et en cours, en leur posant des questions sur l'état actuel de la documentation (rapport 1). Prendre note de tous les systèmes internes utilisés pour suivre les requêtes et les problèmes, ainsi que du processus de documentation dans les documents Open Collective (rapport 2). Évaluation des problèmes latents dans la version actuelle de la documentation et préparation d'un plan pour les résoudre (rapport 3).
2-6 septembre: premier cycle de rétroaction et d'ajustement, prenant en compte tous les commentaires et suggestions faits par la communauté pendant la période de création de liens. Notre plan est-il prêt ? Y a-t-il quelque chose à son sujet qui doit être modifié ? (Rapport 4)
9-20 septembre: développement de la démonstration de faisabilité avec le chapitre moins rempli de la documentation. Ébauche d'un guide de style public (rapport n° 5).
23-25 septembre: soumission de la démonstration de faisabilité pour évaluation (groupe fermé).
26-27 septembre: notre preuve de concept doit-elle être ajustée avant d'être mise en service ? Avez-vous besoin de plus de temps ? Ajustez-les en conséquence. (Rapport 6)
30 septembre – 9 octobre: la preuve de concept est mise en ligne. Deuxième cycle d'avis (groupe public)
Du 10 au 15 octobre: cycle d'évaluation et d'ajustement final de la preuve de concept. (Rapport 7)
Du 16 au 20 octobre: petite pause dans les activités [1].
Du 21 octobre au 23 novembre: le guide de style public est finalisé (rapport n° 8). Application de toutes les instructions du guide de style à toutes les pages de la documentation utilisateur (rapport 9). Rapport évaluant toutes les activités effectuées et proposant d'autres recommandations à la communauté (rapport 10).
La durée du projet peut être prolongée sur demande.
[1] Voyage planifié avant mon inscription à la saison des documents.
Livrables - Dix rapports publics sur les activités effectuées - Un guide de style public que les contributeurs Open Collective et externes peuvent utiliser - Des pages de documentation utilisateur remaniées