Progetto Qubes OS

Questa pagina contiene i dettagli di un progetto di scrittura tecnica accettato per la stagione dei documenti Google.

Riepilogo del progetto

Organizzazione open source:
Sistema operativo Qubes
Technical writer:
c1e0
Nome progetto:
Consolida le guide per la risoluzione dei problemi
Durata del progetto:
Durata standard (3 mesi)

Project description

SINTESI

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 guida alla risoluzione dei problemi efficace è importante perché aiuta gli utenti in caso di problemi. Impedisce agli utenti di abbandonare un prodotto quando riscontrano un problema. Qubes ha migliaia di utenti giornalieri in tutto il mondo, molti dei quali dovranno affrontare un problema in futuro e potranno usufruire di 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 sono prive di un layout basato sui sintomi, il che rende difficile per un utente trovare la soluzione ad un problema. Inoltre, ci sono alcuni problemi che sono stati menzionati più volte sui social media (Reddit), nella pagina dei problemi di Qubes GitHub e sul forum #qubes-users, ma che non sono stati documentati nell'attuale guida alla risoluzione dei problemi.

PERCHÉ LA MIA GUIDA ALLA RISOLUZIONE DEI PROBLEMI PREVISTA MIGLIORA QUELLA ATTUALE?

La guida alla risoluzione dei problemi che proponiamo sarà completa e strutturata per garantire precisione e facilità di navigazione. La guida mostrerà istruzioni concise che spiegano come risolvere un problema in modo dettagliato. Verrà mostrato un layout sintomo-azione, in cui viene indicato un problema, seguito da una soluzione consigliata per risolverlo. Le soluzioni saranno ottimizzate per i motori di ricerca e formulate in modo da tenere conto dei problemi che gli utenti cercano sui social media e sui motori di ricerca. Tutto ciò servirà ad aiutare gli utenti a trovare la guida ufficiale alla risoluzione dei problemi tramite i motori di ricerca e a trovare una soluzione ai loro problemi in modo rapido/facile.

STRUTTURA DELLA GUIDA PROPOSTA ALLA RISOLUZIONE DEI PROBLEMI

Ho creato una struttura proposta per la guida alla risoluzione dei problemi del sistema operativo di Qubes, disponibile 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 per la risoluzione dei problemi. Questo layout verrà implementato dopo il feedback del tutor. 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 in modo da avere un layout più comprensibile e consolidato dell'azione sui sintomi.
  • Riscrivi le soluzioni di risoluzione dei problemi esistenti per avere istruzioni passo passo facili da seguire.
  • Se necessario, aggiungi screenshot
  • Installa e prova Qubes autonomamente e registra gli eventuali problemi riscontrati. Ho tre computer: un Lenovo Thinkpad, Dell Latitude e un Acer Aspire. Proverò Qubes su ciascuno di questi computer, registrando eventuali errori e convalidando eventuali soluzioni.
  • Rimuovi eventuali informazioni obsolete dalla guida esistente.
  • Assicurati che le procedure per la risoluzione dei problemi siano accurate. Al momento, nelle guide alla risoluzione dei problemi esistenti viene visualizzato il messaggio di errore ""Questa è una documentazione non ufficiale di terze parti. Il progetto del sistema operativo di Qubes non può garantire l'accuratezza di questa pagina. Presta attenzione". Questo avviso verrà ignorato una volta verificata l'accuratezza delle istruzioni per la risoluzione dei problemi. La loro precisione sarà garantita testando personalmente le procedure di risoluzione dei problemi sui miei PC (se possibile) o controllando online se qualcuno ha convalidato la soluzione.
  • Esegui la migrazione di eventuali soluzioni esterne (dal forum e da GitHub) alla pagina web ufficiale per la risoluzione dei problemi.
  • Esegui ricerche e trova altri problemi riscontrati dagli utenti di Reddit (r/QubesOS), Stack Exchange, #qubes-users gruppo Google e GitHub. Userò anche strumenti di ricerca delle parole chiave come Keywordtool.io e UberSuggest.com per scoprire quali domande vengono cercate più spesso nei motori di ricerca come Google.
  • Aggiungi una sezione "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/troubleshooting/#sect-troubleshooting-getting-help.

PERCHÉ QUESTO PROGETTO?

Sono appassionata di tecnologia, in particolare di cybersicurezza e privacy. Credo che la scrittura sia uno dei miei strumenti più potenti. Mi interessa in particolare il sistema operativo Qubes perché incrocia due interessi principali: la sicurezza e la privacy. Utilizzo assiduamente altri prodotti incentrati sulla sicurezza e sulla privacy come DuckDuckGo e Tor. Solo di recente ho scoperto Qubes OS e finora l'ho adorato.

PERCHÉ CREDO DI SIA LA PERSONA GIUSTA PER QUESTO PROGETTO

  • Sono appassionata di sicurezza e privacy e mi occupo di scrivere una documentazione valida/utile.
  • Siccome ho riscontrato dei problemi durante l'installazione e l'utilizzo del sistema operativo Qubes, sarò in grado di rappresentarli meglio nelle istruzioni per la risoluzione dei problemi.
  • Il mese scorso ho studiato gli aspetti tecnici del sistema operativo Qubes. Ho anche studiato a fondo la documentazione del sistema operativo Qubes. Per avere un'idea del processo di modifica della documentazione, ho creato una richiesta di pull (https://github.com/QubesOS/qubes-doc/pull/1005/files)
  • Di recente ho completato uno stage presso il progetto Tor. I miei ruoli erano l'assistenza tecnica e la scrittura. Mentre lavoravo all'help desk, ho ricevuto centinaia di domande da utenti che avevano riscontrato problemi durante l'installazione o l'utilizzo del browser Tor. Aiutando questi utenti a risolvere i loro problemi, ho imparato a scrivere istruzioni per la risoluzione dei problemi concise e comprensibili
  • Mentre lavoravo al progetto Tor, ho anche scritto la documentazione tecnica utilizzando Markdown. Ho utilizzato Git, GitHub e GitLab per il controllo della versione.