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:
- luzeal
- Nome progetto:
- Fai l'onboarding con QubesOS! Scriviamo una guida aperta e facile da usare
- Durata del progetto:
- Durata standard (3 mesi)
Project description
Esegui l'onboarding con QubesOS!
Vorrei creare una guida aperta e i materiali correlati per i nuovi utenti di QubesOS. L'obiettivo sarebbe presentare QubesOS alla persona non addetta ai lavori e mantenere la guida il più concisa e comprensibile possibile, utilizzando analogie, illustrazioni e diagrammi. Per mantenerlo consolidato, verranno utilizzati link a risorse affidabili e affidabili, tra cui in primo luogo quelle presenti nel sito web di QubesOS. Tutti gli elementi verranno rilasciati con licenza aperta.
Con il termine "singolo" intendiamo contenuti che possono esistere in modo indipendente rispetto al sito web, ad esempio sotto forma di manuale. Non equivale alla versione offline della guida. Idealmente, si dovrebbe creare un'altra pipeline per pubblicare i contenuti come guida, insieme al sito web.
Con "aperta" intendiamo una guida che verrà pubblicata con licenza aperta.
Come si può fare
Definisci il pubblico di destinazione
A oggi, ho l'impressione che la categoria di utenti a cui si rivolge QubesOS non sia ben definita. In che modo QubesOS può aiutare giornalisti, avvocati, analisti della sicurezza, sviluppatori di software e così via? Sarebbe utile descrivere scenari in cui QubeOS può rivelarsi utile.
Definisci le aspettative nel modo giusto
Sarebbe inoltre importante avvertire i nuovi utenti che QubesOS richiede un buon livello di conoscenza IT. Per l'utilizzo di QubesOS è previsto un costo, soprattutto se il tuo sistema di elaborazione principale è QubesOS. Per quanto riguarda lo stesso token, ci sono cose che QubeOS non farà bene (per progettazione), come l'accelerazione 3D nelle macchine virtuali. È importante chiarirlo fin dall'inizio, non dissuaderlo dall'utilizzare il prodotto, ma impostare delle eccezioni per i potenziali utenti.
Che cos'è QubesOS e cosa non lo è
Nonostante QubesOS sia una tipologia particolare di sistemi operativi (una distribuzione Xen), sarebbe interessante confrontarlo con altri sistemi operativi in base alle loro funzionalità o alla loro mancanza (ad esempio, Windows utilizza sempre più spesso la virtualizzazione e il sandboxing come meccanismi di sicurezza). Puoi utilizzare un semplice diagramma/una tabella.
Le specifiche per la guida verranno definite con la community.
Quali sono le informazioni minime che la guida deve contenere? In che misura è possibile semplificare l'installazione senza rinunciare alla sicurezza? Dove deve essere la soglia? Esiste una configurazione di QubesOS minimamente attuabile e sicura? In caso contrario, potrebbe essere definito e impostato come target per la guida.
Licenza
Ritirare una licenza. Il rispettato wiki di Archlinux usa GNU Free Validation License 1.3 o versioni successive. La licenza sarebbe adatta?
Altri destinatari
Rendere la documentazione del sito web visivamente più accattivante
Le note potevano essere evidenziate con colori rossi o gialli per renderle più visibili. Ad esempio, si potrebbero usare delle caselle colorate, come quelle che si trovano nel wiki archlinux. https://wiki.archlinux.org/index.php/Linux_Containers.
È possibile utilizzare le virgolette.
Contenuti del link
Al momento sono disponibili molti contenuti per il sito web di documentazione, ma le singole parti spesso non sono collegate ad altri argomenti pertinenti. Gli articoli potrebbero essere collegati tra loro per migliorare la rilevabilità.