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:
- Le plus important
- Rédacteur technique:
- @anindita_basu
- Nom du projet:
- Examiner et affiner le texte dans le produit
- Durée du projet:
- Longue durée (cinq mois)
Project description
J'ai rejoint la chaîne Slack et 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) qui sont destinées à la console système et celles qui sont destinées à l'utilisateur. Je propose d'examiner d'abord les chaînes visibles par l'utilisateur.
Créer un guide de style pour les chaînes
Je souhaite définir le style d'utilisation des majuscules, de la longueur et des mots utilisés 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 un exemple de capture d'écran du guide de style à l'adresse https://github.com/AninditaBasu/AninditaBasu.github.io/blob/master/gsod/Capture7.PNG). Je voudrais également vous donner des conseils sur l'utilisation des jetons (espaces réservés) dans les chaînes, en particulier les chaînes composites.
Je m'efforce de limiter ces conseils à une page de format A4, voire moins si possible. L'objectif est que les développeurs qui écrivent ces chaînes trouvent les conseils rapides et faciles à utiliser. De plus, si vous les suivez, le texte de l'interface utilisateur sera cohérent sur tous les écrans.
Je propose de le faire pour deux raisons: (a) afin que le contenu textuel soit cohérent en termes de grammaire et de style ; (b) afin que, même après la fin du GSoD, un ensemble d'instructions puisse être consulté rapidement par tous les concepteurs lorsqu'ils rédigent du texte pour l'interface utilisateur.
Examiner et affiner le texte
En me basant sur le guide de style créé à l'étape 2, je vais modifier les chaînes et créer 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 (ce que je propose d'examiner dans ce projet). Je pense que la création du guide de style prendra environ trois semaines (de la version préliminaire à l'approbation). Ce travail peut être effectué simultanément avec la catégorisation des chaînes en tant que chaînes système ou destinées à l'utilisateur. Je propose de commencer par l'hypothèse que le projet sera un projet de durée standard (3 mois), où je n'accepte que le maximum de chaînes pour examen que possible dans ce délai.
Étant donné que je suis déjà employé à temps plein, je ne pourrais travailler que sur une partie de la journée sur ce projet. Je suis prêt à envisager un projet de plus longue durée si vous pensez que mes heures de travail réduites l'exigent.