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:
- Qubes OS
- Redattore tecnico:
- c1e0
- Nome del progetto:
- Guide alla risoluzione dei problemi consolidate
- Durata del progetto:
- Durata standard (3 mesi)
Project description
ABSTRACT
Una guida alla risoluzione dei problemi è progettata per aiutare gli utenti finali a risolvere eventuali problemi riscontrati durante l'utilizzo di un prodotto o servizio. Una buona guida alla risoluzione dei problemi è importante perché aiuta gli utenti quando si verificano problemi. Impedisce agli utenti di abbandonare un prodotto quando si verifica un problema. Qubes ha migliaia di utenti giornalieri in tutto il mondo, molti dei quali si troveranno ad affrontare un problema a un certo punto e trarranno vantaggio da una guida alla risoluzione dei problemi.
STATO ATTUALE DELLA GUIDA ALLA RISOLUZIONE DEI PROBLEMI
Al momento, le guide alla risoluzione dei problemi di QubesOS sono sparse su molte pagine e a volte sono incomplete, il che porta a pubblicare ripetutamente le stesse istruzioni per aiutare gli utenti a diagnosticare i problemi. Le guide disponibili non hanno un layout dei sintomi e delle azioni, il che rende difficile per un utente associare un problema alla relativa soluzione. Inoltre, alcuni problemi sono stati menzionati ripetutamente sui social media (Reddit), nella pagina dei problemi di GitHub di Qubes e sul forum #qubes-users, ma che non sono stati documentati nell'attuale guida alla risoluzione dei problemi.
PERCHÉ LA GUIDA ALLA RISOLUZIONE DEI PROBLEMI CHE PROPONGO È UN MIGLIORAMENTO RISPETTO A QUELLA ATTUALE?
La guida alla risoluzione dei problemi che propongo sarà completa e strutturata per garantire precisione e facilità di navigazione. La guida mostrerà istruzioni concise che spiegano come risolvere un problema in modo passo passo. Presenta un layout dei sintomi e delle azioni, in cui viene indicato un problema, seguito da una soluzione consigliata per risolverlo. Le soluzioni saranno ottimizzate per i motori di ricerca e verranno formulate in modo da tenere conto dei problemi che gli utenti cercano sui social media e sui motori di ricerca. Tutto ciò contribuirà ad assicurare che gli utenti possano trovare la guida ufficiale alla risoluzione dei problemi tramite i motori di ricerca e trovare rapidamente/facilmente la soluzione ai loro problemi.
STRUTTURA DELLA GUIDA PER LA RISOLUZIONE DEI PROBLEMI PROPOSTA e PERIODO DI TEMPO
Ho creato una struttura proposta per la guida alla risoluzione dei problemi del sistema operativo Qubes che si trova qui: https://docs.google.com/document/d/187NlnEvctYVVUnRuGtwY2PkYBVxBSSPfpSwZEaczqL8/edit?usp=sharing. Il layout è accompagnato da un periodo di tempo stimato durante il quale verrà scritta ogni sezione di risoluzione dei problemi. Questo layout verrà implementato dopo il feedback del mentor. La struttura e il periodo di tempo possono essere modificati in base al feedback del mentore.
OBIETTIVI DEL PROGETTO
- Riorganizza la guida alla risoluzione dei problemi per avere un layout più comprensibile e consolidato dei sintomi.
- Riscrivere le procedure di risoluzione dei problemi esistenti per avere istruzioni passo passo facili da seguire.
- Aggiungi screenshot se necessario
- Installa e prova Qubes e registra gli eventuali problemi riscontrati. Ho tre computer: un Lenovo Thinkpad, un Dell Latitude e un Acer Aspire. Proverò Qubes su ciascuno di questi computer, registrando eventuali errori e convalidando eventuali procedure di risoluzione.
- Rimuovi eventuali informazioni obsolete nella guida esistente.
- Assicurati che le procedure di risoluzione dei problemi siano accurate. Al momento, le guide alla risoluzione dei problemi esistenti contengono il messaggio di errore ""Questa è documentazione di terze parti non ufficiale. Il progetto Qubes OS non può garantire l'accuratezza di questa pagina. Fai attenzione"". Questo avviso verrà ignorato dopo che sarà stata verificata l'accuratezza delle istruzioni per la risoluzione dei problemi. La loro accuratezza sarà garantita testando personalmente le procedure di risoluzione dei problemi sui miei PC (se possibile) o controllando online se altri utenti hanno convalidato la soluzione.
- Esegui la migrazione di eventuali procedure di risoluzione dei problemi esterni (dal forum e da GitHub) alla pagina web ufficiale per la risoluzione dei problemi.
- Cerca e trova altri problemi riscontrati dagli utenti su Reddit (r/QubesOS), Stack Exchange, nel gruppo Google #qubes-users e nei problemi di GitHub. Utilizzerò anche strumenti di ricerca delle parole chiave come Keywordtool.io e UberSuggest.com per scoprire quali domande vengono cercate di frequente su motori di ricerca come Google.
- Aggiungi una sezione "Ricevere assistenza", nel caso in cui la guida alla risoluzione dei problemi non risolva il problema degli utenti. Per un esempio, consulta la pagina di risoluzione dei problemi di Fedora: https://docs.fedoraproject.org/en-US/fedora/rawhide/install-guide/install/troubleshooter/#sect-troubleshooting-getting-help.
PERCHÉ QUESTO PROGETTO?
Sono appassionato di tecnologia, in particolare di cybersicurezza e privacy. Credo che scrivere sia uno dei miei migliori abiti. Sono particolarmente interessato al sistema operativo Qubes perché interseca due dei miei principali interessi: sicurezza e privacy. Sono un utente appassionato di altri prodotti incentrati sulla sicurezza e sulla privacy, come DuckDuckGo e Tor. Ho scoperto Qubes OS solo di recente e lo adoro.
PERCHÉ RITENGO DI ESSERE LA PERSONA GIUSTA PER QUESTO PROGETTO
- Mi appassionano la sicurezza, la privacy e la scrittura di documentazione utile e di qualità.
- Poiché ho riscontrato problemi durante l'installazione e l'utilizzo del sistema operativo Qubes, sarò in grado di rappresentare meglio questi problemi nelle istruzioni per la risoluzione dei problemi.
- Nell'ultimo mese ho studiato gli aspetti tecnici del sistema operativo Qubes. Ho anche studiato a fondo la documentazione di Qubes OS. Per avere un'idea della procedura di modifica della documentazione, ho creato una richiesta pull (https://github.com/QubesOS/qubes-doc/pull/1005/files)
- Di recente ho completato un tirocinio presso il progetto Tor. I miei ruoli erano assistenza tecnica e scrittura. Mentre lavoravo all'helpdesk, ho ricevuto centinaia di domande da utenti che hanno riscontrato problemi durante l'installazione o l'utilizzo di Tor Browser. Aiutando questi utenti a risolvere i loro problemi, ho imparato a scrivere istruzioni di risoluzione dei problemi concise e comprensibili
- Mentre lavoravo al Tor Project, ho anche scritto della documentazione tecnica con Markdown. Ho utilizzato Git, GitHub e GitLab per il controllo delle versioni.