Questa pagina contiene i dettagli di un progetto di scrittura tecnica accettato per la stagione di Documenti Google.
Riepilogo del progetto
- Organizzazione open source:
- Qubes OS
- Redattore tecnico:
- luzeal
- Nome del progetto:
- Esegui 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 materiali correlati per i nuovi utenti di QubesOS. L'obiettivo è introdurre QubesOS ai non addetti ai lavori e mantenere la guida il più concisa e comprensibile possibile, utilizzando analogie, illustrazioni e diagrammi. Per mantenere la guida concisa, verranno utilizzati link a risorse affidabili e attendibili, tra cui innanzitutto quelle presenti sul sito web di QubesOS. Tutti i contenuti verranno rilasciati con una licenza aperta.
Con contenuti autonomi intendo un contenuto che potrebbe esistere indipendentemente dal sito web, ad esempio come manuale. Non equivale alla versione offline della guida. Idealmente, oltre al sito web, verrà creata un'altra pipeline per pubblicare i contenuti come guida.
Per aperta intendo una guida che verrà rilasciata con una licenza aperta.
Come potrebbe essere eseguita
Definisci il pubblico di destinazione
A oggi, ho l'impressione che la categoria di utenti scelta come target da 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 gli scenari in cui QubeOS può essere utile.
Stabilire le aspettative giuste
È inoltre importante avvisare gli utenti alle prime armi che QubesOS richiede un buon livello di conoscenza IT. L'usabilità di QubesOS ha un prezzo, soprattutto se è il tuo sistema di calcolo principale. Nello stesso token, ci sono cose che QubeOS non è in grado di fare bene (secondo la progettazione), come l'accelerazione 3D nelle macchine virtuali. È importante chiarirlo fin dall'inizio, non per scoraggiare le persone dall'utilizzo, ma per impostare delle eccezioni per i potenziali utenti.
Che cos'è QubesOS e cosa non è
Anche se QubesOS è una specie speciale di sistema operativo (una distribuzione Xen), sarebbe interessante confrontarlo con altri sistemi operativi in base alle loro funzionalità o alla loro assenza (ad esempio, Windows utilizza sempre più la virtualizzazione e il sandboxing come meccanismi di sicurezza). Potrebbe essere utilizzato un semplice diagramma/tabella.
Le specifiche della guida verranno definite con la community.
Quali sono le informazioni minime che deve contenere la guida? Quanto può essere semplificata l'installazione senza sacrificare la sicurezza? Dove deve essere la soglia? Esiste una configurazione di QubesOS minimamente praticabile e sicura? In caso contrario, potrebbe essere definito e impostato come target per la guida.
Licenza
Ritira una licenza. Il rispettato wiki di Archlinux utilizza la GNU Free Documentazione License 1.3 o versione successiva. Questa licenza è adatta?
Altri progetti
Rendi la documentazione del sito web più accattivante dal punto di vista visivo
Le note possono essere evidenziate utilizzando colori rossi o gialli per renderle più facilmente visibili. Ad esempio, è possibile utilizzare caselle di colore, come quelle disponibili nella wiki di ArchLinux. https://wiki.archlinux.org/index.php/Linux_Containers.
Potrebbero essere utilizzati i blockquote.
Collegare i contenuti
Al momento, il sito web della documentazione contiene molti contenuti, ma i singoli elementi spesso non sono collegati ad altri argomenti pertinenti. Gli articoli potrebbero essere collegati tra loro per migliorare la rilevabilità.