Questa pagina contiene i dettagli di un progetto di scrittura tecnica accettato per la stagione di Documenti Google.
Riepilogo del progetto
- Organizzazione open source:
- Collettivo aperto
- Redattore tecnico:
- Anna e só
- Nome progetto:
- Migliorare la documentazione generale della guida
- Durata del progetto:
- Durata standard (3 mesi)
Project description
Prime impressioni È frequente trovare pagine di documentazione contenenti istruzioni senza contenuti multimediali di supporto (video, GIF, immagini), mentre altre sezioni dello stesso capitolo hanno voci più complete. Ad esempio, Modifica collettivo è composta solo da istruzioni, mentre Aggiungi host fiscale incorpora contenuti multimediali di supporto.
Nelle pagine che ho sfogliato, non viene descritto alcun contenuto multimediale utilizzando l'attributo di testo alternativo. La mancanza di descrizioni delle immagini impedisce una comprensione completa della documentazione per chi utilizza screen reader e per le persone con connessioni a internet più lente in cui i contenuti multimediali potrebbero non caricarsi.
Alcune sezioni della documentazione uniscono domande frequenti e istruzioni dirette per la navigazione nell'interfaccia utente, ad esempio Cambia host fiscale. Poiché nell'interfaccia della documentazione non è presente un sommario, un utente che conosce le conseguenze di una modifica dei record di registrazione e vuole solo istruzioni oggettive potrebbe percepire la documentazione come prolissa e troppo indiretta.
Sebbene il linguaggio della documentazione tecnica sia abbastanza coerente, la guida di stile disponibile pubblicamente spiega troppo poco su come scrivere la documentazione. Poiché la pagina Contributi menziona i contributi alla documentazione tecnica, sia Open Collective che i potenziali collaboratori beneficerebbero di linee guida più complete.
Proposta Propongo una revisione delle pagine di assistenza per gli utenti, ripensando alla loro presentazione e alla struttura attuale.
Metodologia e tempistiche Voglio migliorare la documentazione di Open Collective lavorando a fianco della community promuovendo cicli di feedback continuo di durata variabile.
Periodo di legame con la comunità (1 agosto - 1 settembre 2019): conoscere la community Open Collective! Intervistare i membri attivi di progetti di rilievo e di partenza, ponendo loro domande sullo stato attuale della documentazione (Report n. 1). Prendere nota di tutti i sistemi interni utilizzati per monitorare query e problemi e della procedura per documentarli in Open Collective Docs (report 2). Valutazione dei problemi latenti nella versione corrente della documentazione e preparazione di un piano per risolverli (report 3).
2-6 settembre: primo ciclo di feedback e aggiustamento, che prende in considerazione tutti i commenti e i suggerimenti fatti dalla community durante il periodo di affiatamento con la community. Il nostro piano va bene? C'è qualcosa che deve essere modificato? (Report n. 4)
9-20 settembre: sviluppo della proof of concept con il capitolo meno completo della documentazione. Bozza di una guida di stile pubblica (report n. 5).
23-25 settembre: invio del proof of concept per la valutazione (gruppo chiuso).
26-27 settembre: la nostra prova del concetto richiede modifiche prima di essere pubblicata? Abbiamo bisogno di più tempo? Regola di conseguenza. (Report n. 6)
30 settembre - 9 ottobre: la proof of concept viene pubblicata. Secondo ciclo di feedback (gruppo pubblico).
10-15 ottobre: ciclo di valutazione e aggiustamento finale della prova del concetto. (Report n. 7)
16-20 ottobre: breve pausa dalle attività [1].
21 ottobre - 23 novembre: la Guida di stile pubblica è definitiva (report n. 8). Applicazione di tutte le istruzioni presenti nella Guida di stile a tutte le pagine della documentazione per l'utente (rapporto n. 9). Report che valuta tutte le attività svolte e ulteriori consigli per la community (report 10).
La durata del progetto può essere estesa su richiesta.
[1]: Viaggio pianificato prima della mia candidatura per la stagione di Documenti.
Materiali da produrre - Dieci report pubblici sulle attività svolte - Una guida di stile pubblica utilizzabile sia da Open Collective che da collaboratori esterni - Pagine della documentazione utente rinnovate