Questa pagina contiene i dettagli di un progetto di scrittura tecnica accettato per la stagione dei documenti Google.
Riepilogo del progetto
- Organizzazione open source:
- Progetto FreeBSD
- Technical writer:
- quaffeina
- Nome progetto:
- Creare un capitolo della guida di Wine
- Durata del progetto:
- Durata standard (3 mesi)
Project description
Nell'ambito di questa iniziativa, produrrei un capitolo dettagliato e completo del Manuale di FreeBSD relativo all'installazione, all'utilizzo e alla risoluzione dei problemi di WINE (www.winehq.org) su FreeBSD. Se non diversamente specificato, vorrei dedicare 4-8 ore alla settimana a lavorare sugli elementi riportati di seguito.
*** Legami della community
Se selezionato, passerei il periodo di Community Bonding per familiarizzare con i processi e l'infrastruttura della documentazione del progetto FreeBSD. La documentazione coerente fornita dal progetto mi ha sempre colpito e ho voluto interagire con i membri del team del progetto riguardo al loro flusso di lavoro. Vorrei anche partecipare e sfogliare i forum orientati agli utenti per avere un'idea di cosa aiuterebbero gli utenti di FreeBSD per quanto riguarda la documentazione in generale e per aiutare a lavorare con WINE su FreeBSD in particolare.
Durante questo periodo dedicherei un po' di tempo ad apprendere la Toolchain della documentazione del progetto. Questo mi consentirà di partire con il piede giusto durante le prime settimane del progetto.
*** Settimana 1 (14/9-19): Installazioni di prova e risoluzione dei problemi
La prima settimana della fase di sviluppo di Documenti, la prima settimana di sviluppo di Doc, ci dedicherei a un'installazione di prova di WINE sulla versione stabile corrente di FreeBSD, oltre all'installazione e all'esecuzione di una varietà di applicazioni Windows che vanno dalle semplici utilità alle applicazioni più complesse. Questo è un approccio che ho adottato in un articolo simile che ho fatto su ReactOS per MakeUseOf (https://www.makeuseof.com/tag/reactos-open-source-windows-clone/), solo che utilizzerei il tempo della prima settimana per esaminare una selezione più ampia di programmi.
In base alla mia esperienza, dedicare questo tipo di tempo in anticipo è utile per identificare (e risolvere) tipi di problemi generici "gotcha". In questo modo potrei avere le soluzioni a disposizione quando è il momento di scrivere le sezioni pertinenti o almeno presentare richieste di assistenza ai canali appropriati.
Obiettivo della settimana: avere una panoramica dei capitoli di installazione e i dettagli necessari per la risoluzione dei problemi di installazione più comuni.
*** Settimana 2 (21/09-25): Documentare l'installazione di WINE
Durante la Settimana 2 creerei una bozza delle sezioni che illustrano l'installazione di WINE attraverso i metodi più diffusi, tra cui:
- Dall'origine utilizzando il sistema di porte;
- Tramite pacchetti binari che usano repository principali.
- Utilizzando i gestori di pacchetti GUI disponibili, se disponibili; e
- Da repository alternativi come FreshPorts (e perché un utente dovrebbe volerlo fare).
In questa sezione è importante parlare delle installazioni a 32 e a 64 bit e simultanee, per evidenziare i passaggi aggiuntivi richiesti dall'esecuzione di programmi di architetture diverse.
Obiettivo della settimana: una bozza elegante delle sezioni che descrivono l'installazione di WINE su FreeBSD. Questa ""bozza lucida"" dovrebbe comprendere un testo quasi definitivo (in attesa di correzione bozza e feedback relativo alla revisione) e segnaposto per gli screenshot, se non gli screenshot stessi.
*** Settimana 3 (28/09-10/2): Ti presentiamo il tuo primo programma WINE su FreeBSD
Una volta installato il sottosistema WINE, nella sezione successiva verranno spiegate in dettaglio l'installazione e l'esecuzione di alcuni programmi iniziali. Molto probabilmente si concentrerebbero su utilità semplici e autonome, come Notepad++ open source. L'obiettivo è consentire agli utenti di scaricare e installare rapidamente un'applicazione e vederla funzionare con il minimo impegno.
Questa sezione è importante per dimostrare agli utenti che alcune e molte applicazioni Windows possono effettivamente essere eseguite su FreeBSD, rendendola una scelta praticabile nell'informatica di tutti i giorni.
Obiettivo della settimana: identificazione di un numero limitato di programmi che si installano in modo pulito e (in gran parte) pronti all'uso e una bozza elegante delle sezioni che ne illustri l'installazione.
*** Settimana 4 (5/10-9): Panoramica e concetti di vino
Alla fine della sezione precedente alluderebbe alla necessità di mettere a punto e personalizzare alcune applicazioni per far funzionare determinate applicazioni su WINE. A questo punto, un'introduzione al sottosistema WINE è utile per fornire un contesto. Queste sezioni esamineranno cosa viene fornito con il sistema WINE, come interagisce con FreeBSD e dove un utente potrebbe iniziare a cercare di comprendere meglio il sistema o risolvere i problemi.
È importante notare che questa sezione non mira a duplicare le risorse esistenti, ma a presentare una panoramica organizzata che rimandi ad altre fonti (facilmente comprensibili) per ulteriori informazioni.
Obiettivo della settimana: una bozza accurata delle sezioni che introducono il sottosistema WINE agli utenti.
*** Settimana 5 (10/12-16): WINE Configuration su FreeBSD
Queste sezioni approfondirebbero ulteriormente la configurazione effettiva di WINE, a partire dalle modifiche/regolazioni generali specifiche di FreeBSD. Illustreranno inoltre l'utilizzo delle cartelle $WINEPREFIX, che possono essere utilizzate per personalizzare l'ambiente WINE per una particolare applicazione. Poiché esistono già delle risorse che spiegano questo concetto in modo approfondito, questa sezione fornisce solo un'introduzione moderatamente dettagliata prima di collegarli con te.
Obiettivi della settimana: una bozza accurata delle sezioni che descrive in dettaglio dove, come e in quali circostanze la configurazione approfondita di WINE è richiesta.
*** Settimana 6 (19/10-23): GUI di WINE su FreeBSD
Nella misura in cui configurare WINE per la gestione di un determinato programma può risultare un esercizio complesso e dispendioso in termini di tempo, esistono strumenti di supporto per semplificare questo processo. Queste sezioni forniscono una panoramica dell'installazione e dell'utilizzo di alcune delle opzioni disponibili su FreeBSD, tra cui:
- WINECfg
- truffe
- Playonbsd
- altri se disponibili
Obiettivo della settimana: fornire sezioni in bozza ben definite con istruzioni per l'installazione e l'utilizzo del maggior numero possibile di applicazioni di supporto GUI WINE.
*** Settimana 7 (26/10-30): Domande frequenti su WINE/FreeBSD (Ricerca)
Alcune delle informazioni più preziose riguardanti applicazioni tecniche complesse come WINE si possono trovare nell'interazione tra gli utenti che cercano di risolvere problemi particolari e gli esperti che forniscono risposte. Fa risparmiare molto tempo agli utenti se alcune di queste domande frequenti, in particolare quelle che sono notoriamente interessate dagli utenti di FreeBSD, vengono raccolte in un'unica posizione.
Queste sezioni mirano proprio a questo. Dedicando questa settimana alla ricerca dei tipi di problemi che gli utenti di FreeBSD hanno comunemente con WINE, oltre a cercare e, per quanto possibile, testare le risposte. In questo modo, i lettori di questo capitolo del Manuale avranno maggiori possibilità di risolvere rapidamente un particolare problema.
Queste sezioni includono anche un elenco di risorse su dove cercare le risposte che non ha fornito.
Obiettivo della settimana: bozze di sezioni selezionate contenenti i problemi più comuni relativi a WINE, riscontrati dagli utenti di FreeBSD o in generale, e link/note relative alle loro soluzioni. Tieni presente che, anche se il lavoro di questa settimana non ha una bozza, sarà probabilmente necessario un investimento più lungo in termini di tempo per individuare e riconciliare i problemi comuni e per rintracciare le relative soluzioni. Prevedo di dedicare circa 8-10 ore a questa ricerca.
*** Settimana 8 (2/11-6): Domande frequenti su WINE/FreeBSD
Questa settimana sintetizzava la ricerca della Settimana 7 per creare le sezioni sulle domande frequenti/problemi comuni per la risoluzione dei problemi (con link alle soluzioni appropriate).
Obiettivo della settimana: una bozza corretta delle sezioni che elencano le domande frequenti/i problemi riscontrati di frequente e le istruzioni dettagliate per risolverli.
*** Settimana 9 (9/11-13): amministrazione WINE multiutente
Queste sezioni forniscono indicazioni agli amministratori che intendono eseguire il deployment di WINE in uno scenario multiutente. Includerebbe non solo le best practice per condividere il sottosistema stesso tra più utenti, ma anche per quanto riguarda le applicazioni Windows distribuite in WINE.
Obiettivo della settimana: una bozza elegante di sezioni con indicazioni e best practice per gli amministratori di FreeBSD per il deployment di applicazioni basate su WINE e WINE a più utenti.
*** Settimana 10 (11/16-20): Appendici, Feedback e Amministrazione
Anche se mi sarei impegnato a implementare il feedback ricevuto da mentori e altri revisori durante la procedura di redazione, questa settimana mi darebbe tempo per una riorganizzazione/riscrittura più approfondita, se necessario.
Inoltre, scriverò qualsiasi administrivia richiesta per questo capitolo del Manuale (argomento frontale, indici, ecc.) durante questo periodo, oltre ad assemblare ulteriori letture correlate a WINE (ad esempio usando la versione Linux di WINE attraverso la compatibilità binaria, DOSBox per vecchi giochi/programmi, ecc.).
Obiettivo della settimana: una bozza accurata dell'intero capitolo del manuale, comprese tutte le altre sezioni.
*** Settimana 11 (23/11-27): Finalizzazione del capitolo del manuale
Ho intenzione di dedicare questa seconda alla scorsa settimana alla correzione di tutto il testo, al controllo delle immagini e al test dei vari output (HTML, PDF e così via) secondo necessità. Questa settimana consentirà anche di effettuare aggiornamenti nel caso in cui uno dei software sopra indicati (da FreeBSD stesso a WINE o i suoi aiutanti) venga aggiornato in tempo dalla prima scrittura.
Obiettivo della settimana: versione finale del capitolo del manuale, inclusi tutti gli aggiornamenti necessari.
*** Settimana 12 (30/11-5/11): Finalizzazione del progetto
Con l'accordo con i mentori del progetto, controllare il capitolo del Manuale sul controllo del codice sorgente, assemblare il report sul progetto e inviare il progetto come completo.