Questa pagina contiene i dettagli di un progetto di documentazione tecnica accettato per la stagione della documentazione di Google.
Riepilogo del progetto
- Organizzazione open source:
- Mattermost
- Redattore tecnico:
- @anindita_basu
- Nome progetto:
- Rivedere e perfezionare il testo all'interno del prodotto
- Durata del progetto:
- A lungo termine (5 mesi)
Project description
Ho aderito al canale Slack e ho inviato alcune domande a 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 relative alla console di sistema e quali sono rivolte agli utenti. Propongo di esaminare inizialmente le stringhe rivolte agli utenti.
Crea una guida di stile per le stringhe
Vorrei definire lo stile per l'uso di lettere maiuscole, lunghezza e 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 fornire alcune indicazioni sull'uso dei token (segnaposto) nelle stringhe, in particolare nelle stringhe composte.
Mi impegno a limitare queste indicazioni a una pagina di un foglio A4, più breve se possibile. L'intenzione è che gli sviluppatori che scrivono effettivamente queste stringhe dovrebbero trovare indicazioni rapide e facili da usare. Inoltre, se seguito, il testo dell'UI mostrerà la coerenza su tutte le schermate.
Propongo di farlo per due motivi: (a) per garantire la coerenza del testo in termini di grammatica e stile (b) per fare in modo che, anche al termine del GSoD, sia disponibile un insieme 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 in GitHub.
=============
Durata
Non so ancora quante stringhe sono rivolte agli utenti (che è ciò che propongo di esaminare in questo progetto). Stimo che la creazione della guida di stile richieda circa 3 settimane (dalla bozza all'approvazione) e che questo lavoro possa essere svolto contemporaneamente alla classificazione delle stringhe come stringhe di sistema o rivolte agli utenti. Propongo di iniziare con l'ipotesi che il progetto avrà una durata standard (3 mesi), in cui prenderò in considerazione solo le stringhe per la revisione che possono essere possibili in questo periodo di tempo.
Dato che sono già assunto a tempo pieno, potrei lavorare a questo progetto solo per una parte della giornata. Sono disponibile per un progetto di durata maggiore, se ritieni che le mie ore di lavoro ridotte lo richiedano.