Questa pagina contiene i dettagli di un progetto di scrittura tecnica accettato per la stagione dei documenti Google.
Riepilogo del progetto
- Organizzazione open source:
- Collettivo aperto
- Technical writer:
- Anna e só
- Nome progetto:
- Migliora la documentazione di assistenza generale
- Durata del progetto:
- Durata standard (3 mesi)
Project description
Prime impressioni Capita spesso che vengano visualizzate pagine di documentazione contenenti istruzioni che non supportano contenuti multimediali (video, GIF, immagini), mentre altre sezioni dello stesso capitolo contengono voci più complete. Ad esempio, Edit Collective è composta solo da istruzioni, mentre Add Fiscal Host incorpora i contenuti multimediali di supporto.
Nelle pagine che ho sfogliato, non viene descritto nessun contenuto multimediale utilizzando l'attributo testo alternativo. La mancanza di descrizioni delle immagini ostacola una comprensione completa della documentazione per chi usa screen reader e per chi usa connessioni a internet più lente in cui eventuali contenuti multimediali potrebbero non caricarsi.
Alcune sezioni delle domande frequenti sull'unione della documentazione e istruzioni dirette per la navigazione nell'interfaccia utente, ad esempio Modifica host fiscale. Poiché l'interfaccia della documentazione non contiene un sommario, un utente che è consapevole delle conseguenze di una modifica nei dati di registrazione e vuole solo istruzioni oggettive potrebbe considerare la documentazione dettagliata e troppo tangenziale.
Sebbene il linguaggio della documentazione tecnica sia abbastanza coerente, la Guida di stile disponibile pubblicamente documenta troppo poco il modo in cui la documentazione dovrebbe essere scritta. Poiché la pagina Contributo menziona i contributi alla documentazione tecnica, sia Open Collective sia i potenziali collaboratori potrebbero trarre vantaggio da linee guida più complete.
Proposta Propongo una revisione delle pagine di assistenza degli utenti, ripensando la loro presentazione e la struttura attuale.
Metodologia e tempistiche Voglio migliorare la documentazione di Open Collective collaborando con la community promuovendo cicli di feedback continuo di diversa durata.
Periodo di legame con la community (1° agosto - 1° settembre 2019): conoscere la community Open Collective! Intervistare i membri attivi di progetti influenti e di quelli iniziali, ponendo loro domande sullo stato attuale della documentazione (Rapporto 1). Prendiamo nota di tutti i sistemi interni utilizzati per monitorare query e problemi e della procedura per documentarli nei documenti collettivi aperti (report n. 2). Valutazione di problemi latenti nella versione attuale della documentazione e preparazione di un piano per risolverli (Report n. 3).
2-6 settembre: primo ciclo di feedback e adattamento, tenendo conto di tutti i commenti e i suggerimenti della community durante il periodo di legame tra comunità. Il nostro piano è valido? C'è qualcosa che deve cambiare? (Rapporto 4)
9-20 settembre: sviluppo di proof of concept con il capitolo meno popolato 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 proof of concept necessita di modifiche prima di essere pubblicata? Serve più tempo? Regolare di conseguenza. (Rapporto 6)
30 settembre - 9 ottobre: Proof of concept sarà disponibile. Secondo ciclo di feedback (gruppo pubblico).
10-15 ottobre: finale di valutazione proof of concept e ciclo di aggiustamento. (Rapporto 7)
16-20 ottobre: piccola pausa dalle attività [1].
21 ottobre - 23 novembre: la guida di stile pubblica è definitiva (Rapporto n. 8). Applicazione di tutte le istruzioni presenti nella Guida di stile a tutte le pagine della documentazione per l'utente (Rapporto n. 9). Rapporto che valuta tutte le attività svolte e ulteriori consigli per la community (Rapporto n. 10).
La durata del progetto può essere estesa su richiesta.
[1]: Viaggio pianificato prima della mia richiesta per la stagione dei documenti.
Risultati - Dieci report pubblici sulle attività eseguite - Una guida di stile pubblica utilizzabile sia da Open Collective sia da chi contribuisce all'esterno - Pagine della documentazione per l'utente rinnovate