Questa pagina contiene i dettagli di un progetto di scrittura tecnica accettato per Google Season of Docs.
Riepilogo del progetto
- Organizzazione open source:
- Pratica
- Technical writer:
- @anindita_basu
- Nome progetto:
- Rivedi e perfeziona il testo interno al prodotto
- Durata del progetto:
- Lunga esecuzione (5 mesi)
Project description
Sono entrata nel canale Slack e ho posto 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. All'inizio propongo di esaminare le stringhe rivolte agli utenti.
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.
Vorrei mantenere queste indicazioni su una pagina di un foglio in formato A4, se possibile è più breve. Con l'intenzione, gli sviluppatori che scrivono effettivamente queste stringhe dovrebbero trovare le indicazioni rapide e facili da usare. Inoltre, se seguito, il testo dell'interfaccia utente mostrerà coerenza su tutti gli schermi.
Propongo di farlo per due motivi: (a) per garantire coerenza nella materia di testo in termini di grammatica e stile (b) in modo che anche al termine di GSoD, ci sia una serie di istruzioni a cui chiunque possa fare riferimento rapidamente quando scrive il testo dell'interfaccia utente
Rivedi e perfeziona 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 sono rivolte all'utente (e questo è quello che propongo di prendere per la revisione in questo progetto). Secondo le nostre stime, la creazione della guida di stile richiederà circa 3 settimane (dalla bozza all'approvazione) e questa operazione può essere eseguita in contemporanea con la classificazione delle stringhe come stringhe di sistema o per l'utente. Propongo di iniziare supponendo che il progetto sia di lunghezza 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 possa essere necessario per il mio orario di lavoro ridotto.