Questa pagina contiene i dettagli di un progetto di scrittura tecnica accettato per la stagione dei documenti Google.
Riepilogo del progetto
- Organizzazione open source:
- Mattermost
- Technical writer:
- @anindita_basu
- Nome progetto:
- Rivedi e perfeziona il testo del prodotto
- Durata del progetto:
- Lunga esecuzione (5 mesi)
Project description
Mi sono iscritto al canale Slack e ho risposto ad alcune domande ad Eric. In base
alla sua risposta (grazie, Eric!), Propongo di affrontare questo progetto nel
seguente modo:
Classificare le stringhe
Inizierò identificando quali stringhe (https://github.com/mattermost/mattermost-webapp/blob/master/i18n/en.json) sono quelle della console di sistema e quali sono rivolte agli utenti. Propongo di prendere in esame le stringhe rivolte all'utente all'inizio.
Creare una guida di stile per le stringhe
Vorrei definire lo stile per le lettere maiuscole, la lunghezza e l'utilizzo delle parole per le stringhe utilizzate in voci di menu, pulsanti di azione, etichette, intestazioni, descrizioni comando, errori, avvisi, convalide, notifiche e conferme (vedi uno screenshot di esempio della guida di stile all'indirizzo https://github.com/AninditaBasu/AninditaBasu.github.io/blob/master/gsod/Capture7.PNG). Inoltre, vorrei creare alcune indicazioni sull'uso dei token (segnaposto) nelle stringhe, in particolare nelle stringhe composte.
Mi propongo di mantenere queste indicazioni su una sola pagina di un foglio in formato A4, se possibile più breve. Intendiamo, gli sviluppatori che scrivono effettivamente queste stringhe dovrebbero trovare le indicazioni facili e veloci da usare, inoltre, se seguito, il testo dell'interfaccia utente mostrerà coerenza su tutti gli schermi.
Propongo di farlo per due motivi: (a) in modo che la pratica del testo sia coerente in termini di grammatica e stile (b) in modo che anche al termine di GSoD, ci sia una serie di istruzioni a cui chiunque può fare rapidamente riferimento quando scrive il testo dell'interfaccia utente
Esaminare e perfezionare il testo
In base alla guida di stile creata al punto 2, modificherò le stringhe e creerò richieste di pull su GitHub.
=============
Durata
Non so ancora quante stringhe siano rivolte all'utente (e questo è quello che propongo di prendere per la revisione in questo progetto). Secondo le mie stime, la creazione della guida di stile richiederebbe circa 3 settimane (dalla bozza all'approvazione) e questo lavoro può essere svolto in contemporanea con la classificazione delle stringhe come stringhe di sistema o rivolte all'utente. Propongo di iniziare partendo dal presupposto che il progetto sarà di durata standard (3 mesi), in cui prendo solo il maggior numero possibile di stringhe per la revisione in questo lasso di tempo.
Poiché sono già un dipendente a tempo pieno, sarei in grado di lavorare solo parte della giornata a questo progetto. Sono favorevole alla possibilità di un progetto di maggiore durata se ritieni che il mio orario di lavoro ridotto ne avrà bisogno.