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:
- Le plus important
- Rédacteur technique:
- @anindita_basu
- Nom du projet:
- Examiner et affiner le texte intégré
- Durée du projet:
- Exécution de longue durée (5 mois)
Project description
J'ai rejoint la chaîne Slack et j'ai envoyé quelques questions à Eric. D'après
sa réponse (merci Eric !), Je propose d'aborder ce projet
de la manière suivante:
Classer les chaînes
Je vais commencer par identifier les chaînes (https://github.com/mattermost/mattermost-webapp/blob/master/i18n/en.json) correspondant à la console système et celles qui sont présentées aux utilisateurs. Je propose de commencer par examiner les chaînes présentées aux utilisateurs.
Créer un guide de style pour les chaînes
Je souhaite définir le style des majuscules, de la longueur et de l'utilisation des mots pour les chaînes utilisées dans les éléments de menu, les boutons d'action, les libellés, les en-têtes, les info-bulles, les erreurs, les avertissements, les validations, les notifications et les confirmations (voir une capture d'écran du guide de style sur https://github.com/AninditaBasu/AninditaBasu.github.io/blob/master/gsod/Capture7.PNG). J'aimerais également vous donner quelques conseils sur l'utilisation de jetons (espaces réservés) dans les chaînes, en particulier dans les chaînes composites.
Je m'efforce de limiter ces conseils à une seule page d'une feuille A4, et de la raccourcir si possible. En effet, les développeurs qui écrivent réellement ces chaînes doivent trouver les conseils rapides et faciles à utiliser. Lorsqu'ils sont suivis, le texte de l'interface utilisateur est cohérent sur tous les écrans.
Je propose de le faire pour deux raisons: (a) pour assurer la cohérence au niveau de la grammaire et du style du texte (b) pour qu'une fois la GSoD terminée, il existe un ensemble d'instructions auxquelles tout le monde peut se référer rapidement lorsqu'il écrit un texte d'interface utilisateur
Examiner et affiner le texte
En me basant sur le guide de style créé à l'étape 2, je modifierai les chaînes et créerai des demandes d'extraction sur GitHub.
=============
Durée
Je ne sais pas encore combien de chaînes sont des chaînes visibles par l'utilisateur (c'est ce que je propose d'examiner dans ce projet). J'estime que la création du guide de style nécessiterait environ trois semaines (du brouillon à l'approbation), et ce travail peut être effectué simultanément avec la catégorisation des chaînes en tant que chaînes système ou présentées aux utilisateurs. Je propose de commencer par l'hypothèse que le projet est un projet d'une durée standard (3 mois), où je n'accepte que le nombre de chaînes de révision possible pendant cette période.
Comme je suis déjà employé à temps plein, je ne pourrais travailler qu'une partie de la journée sur ce projet. Je suis ouvert à la possibilité d'un projet de plus longue durée si vous pensez que mon temps de travail réduit en aura besoin.