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:
- Il progetto FreeBSD
- Redattore tecnico:
- quaffeine
- Nome del progetto:
- Crea un capitolo nella guida di Wine
- Durata del progetto:
- Durata standard (3 mesi)
Project description
Nell'ambito di questa iniziativa, produrrò un capitolo approfondito del Manuale di FreeBSD relativo all'installazione, all'utilizzo e alla risoluzione dei problemi di WINE (www.winehq.org) su FreeBSD. Salvo diversa indicazione, dedicherò alle 4-8 ore a settimana di lavorare sugli elementi che seguono.
*** Community Bonding
Se selezionato, durante il periodo di inserimento nella community mi abituerò alle procedure e all'infrastruttura di documentazione del progetto FreeBSD. Ho sempre apprezzato la documentazione coerente del progetto e mi piacerebbe interagire con i membri del team del progetto in merito al loro flusso di lavoro. Inoltre, ti consiglio di partecipare e sfogliare i forum orientati agli utenti per avere un'idea di cosa potrebbe essere utile per gli utenti di FreeBSD in merito alla documentazione in generale e all'utilizzo di WINE su FreeBSD in particolare.
Ti consiglio di dedicare un po' di tempo a questo periodo per apprendere la toolchain della documentazione del progetto. In questo modo, se sarò selezionato, potrò iniziare subito a lavorare nelle prime settimane del progetto.
*** Settimana 1 (14-19 settembre): test delle installazioni e risoluzione dei problemi
Durante la prima settimana della fase di sviluppo della documentazione, eseguirò un'installazione di prova di WINE sulla versione stabile corrente di FreeBSD, oltre a installare ed eseguire una serie di applicazioni Windows, da semplici utilità ad applicazioni più complesse. Questo è un approccio che ho adottato in un articolo simile che ho scritto su ReactOS per MakeUseOf (https://www.makeuseof.com/tag/reactos-open-source-windows-clone/), solo che userei il tempo della prima settimana per esaminare una selezione più ampia di programmi.
Secondo la mia esperienza, dedicare questo tipo di tempo in anticipo è utile per identificare (e risolvere) i problemi generali di tipo "stai attento". In questo modo, potrei avere le soluzioni a portata di mano quando sarà il momento di scrivere le sezioni pertinenti o, almeno, inviare richieste di assistenza ai canali appropriati.
Obiettivo della settimana: avere una panoramica dei capitoli sull'installazione e i dettagli necessari per risolvere i problemi di installazione più comuni.
*** Settimana 2 (21-25 settembre): documentazione dell'installazione di WINE
Durante la seconda settimana, preparerò la bozza delle sezioni che illustrano l'installazione di WINE tramite i metodi più diffusi, tra cui:
- Dall'origine utilizzando il sistema di porte.
- Tramite pacchetti binari che utilizzano i repository principali.
- Utilizzare i gestori pacchetti GUI disponibili, se disponibili.
- Da repository alternativi come FreshPorts (e perché un utente dovrebbe farlo).
In questa sezione è importante discutere delle installazioni simultanee e a 32 e 64 bit per evidenziare i passaggi aggiuntivi richiesti per l'esecuzione di programmi di architetture diverse.
Obiettivo della settimana: una versione definitiva della bozza delle sezioni che descrivono l'installazione di WINE su FreeBSD. Questa ""bozza perfezionata"" dovrebbe includere un testo quasi definitivo (in attesa di correzione e feedback della revisione) e segnaposto per gli screenshot, se non gli screenshot stessi.
*** Settimana 3 (28/09-02/10): Eseguire il primo programma WINE su FreeBSD
Una volta installato il sottosistema WINE, la sezione successiva descriverà l'installazione e l'esecuzione di alcuni programmi iniziali. Probabilmente si concentrerebbero su utilità semplici e autonome, come Notepad++ open source. L'obiettivo è consentire agli utenti di scaricare rapidamente un'applicazione, installarla e vederla funzionare con il minimo sforzo.
Questa sezione è importante per dimostrare agli utenti che alcune o molte applicazioni Windows possono effettivamente essere eseguite su FreeBSD, il che la rende una scelta attuabile per l'informatica di tutti i giorni.
Obiettivo della settimana: identificare un numero limitato di programmi che si installano correttamente e funzionano (in larga misura) subito dopo l'installazione, nonché una versione definitiva delle sezioni che illustrano la loro installazione.
*** Settimana 4 (5-9 ottobre): Panoramica e concetti di WINE
La fine della sezione precedente allude alla necessità di eseguire alcune ottimizzazioni e personalizzazioni per far funzionare determinate applicazioni su WINE, a questo punto è utile un'introduzione al sottosistema WINE per fornire il contesto. Queste sezioni esamineranno i componenti del sistema WINE, la sua interazione con FreeBSD e dove un utente potrebbe iniziare a cercare di comprendere ulteriormente il sistema o risolvere i problemi.
È importante notare che questa sezione non ha lo scopo di duplicare le risorse esistenti, ma piuttosto di presentare una panoramica organizzata che rimandi ad altre fonti (di facile assimilazione) per ulteriori informazioni.
Obiettivo della settimana: una bozza perfezionata delle sezioni che presentano il sottosistema WINE agli utenti.
*** Settimana 5 (12-16 ott): configurazione di WINE su FreeBSD
Queste sezioni approfondiscono la configurazione effettiva di WINE, a partire da modifiche/ottimizzazioni generali specifiche per FreeBSD. Descriverebbero inoltre l'uso di cartelle $WINEPREFIX, che possono essere utilizzate per personalizzare l'ambiente wine per una particolare applicazione. Poiché esistono risorse che spiegano questo concetto in modo approfondito, questa sezione fornirà solo un'introduzione moderatamente dettagliata prima di fornire i link.
Obiettivi della settimana: una bozza perfezionata delle sezioni che descrivono dove, come e in quali circostanze è necessaria una configurazione approfondita di WINE.
*** Settimana 6 (19/10-23): GUI del VINO su FreeBSD
Poiché la configurazione di WINE per l'esecuzione di un determinato programma può essere un'operazione complessa e dispendiosa in termini di tempo, esistono strumenti di assistenza per semplificare questa procedura. Queste sezioni forniscono una panoramica dell'installazione e dell'utilizzo di alcune delle opzioni disponibili su FreeBSD, tra cui:
- WINECfg
- winetricks
- playonbsd
- altri, se disponibili
Obiettivo della settimana: fornire sezioni in bozza rifinite con istruzioni sull'installazione e l'utilizzo del maggior numero possibile delle applicazioni helper GUI più popolari.
*** Settimana 7 (26-30 ott): domande frequenti su WINE/FreeBSD (ricerca)
Alcune delle informazioni più preziose riguardanti applicazioni tecniche complesse come wine si trovano nell'interazione tra gli utenti che cercano di risolvere problemi specifici e gli esperti che forniscono risposte. Gli utenti risparmierebbero molto tempo se alcune di queste domande frequenti, in particolare quelle che interessano gli utenti di FreeBSD, fossero raccolte in un unico posto.
Queste sezioni avranno proprio questo scopo e questa settimana mi occuperò solo di esaminare i tipi di problemi che gli utenti di FreeBSD riscontrano comunemente con WINE, nonché di trovare e (se possibile) testare le risposte. In questo modo i lettori di questo capitolo del Manuale avranno maggiori possibilità di risolvere rapidamente un problema specifico.
Queste sezioni includeranno anche un elenco di risorse su dove cercare le risposte che non ha fornito.
Obiettivo della settimana: sezioni di bozze perfezionate contenenti i problemi WINE più comuni, riscontrati dagli utenti di FreeBSD o in generale, e link/note relative alle relative soluzioni. Tieni presente che, anche se il lavoro di questa settimana non prevede l'output di una bozza, probabilmente richiederà un investimento di tempo maggiore per trovare e riconciliare i problemi comuni, nonché per individuare le relative soluzioni. Prevedo di dedicare circa 8-10 ore a questa ricerca.
*** Settimana 8 (2/11-6): FAQ su Wine/FreeBSD
Questa settimana verrà utilizzata per sintetizzare la ricerca della Settimana 7 al fine di creare le sezioni relative alle domande frequenti/ai problemi di risoluzione dei problemi comuni (con link alle soluzioni, se opportuno).
Obiettivo della settimana: una bozza perfezionata 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 offrono indicazioni agli amministratori che vogliono implementare 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 implementate in WINE.
Obiettivo della settimana: una bozza di sezione curata con linee guida e best practice per gli amministratori di FreeBSD relative al deployment di applicazioni basate su wine e wine a più utenti.
*** Settimana 10 (16/11-20): Appendici, Revisione del Feedback e Amministrazione
Cercherò di implementare tutti i feedback ricevuti da mentor e altri revisori durante la stesura, ma questa settimana mi darà il tempo di riorganizzare/riscrivere più ampiamente il testo, se necessario.
Inoltre, durante questo periodo scriverò le informazioni amministrative necessarie per questo capitolo del Manuale (premessa, indici e così via), nonché raccoglierò ulteriori letture relative a WINE (ad esempio l'utilizzo della versione Linux di WINE tramite compatibilità binaria, DOSBox per vecchi giochi/programmi e così via).
Obiettivo della settimana: una bozza curata dell'intero capitolo della Guida, comprensiva di tutte le altre sezioni.
*** Settimana 11 (23-27/11): completamento del capitolo del manuale
Ho intenzione di dedicare questa penultima settimana alla correzione di bozza di tutto il testo, al controllo delle immagini e al test dei vari output (HTML, PDF e così via) in base alle necessità. Questa settimana consentirà anche di aggiornamenti nel caso in cui uno qualsiasi dei software sopra indicati (da FreeBSD stesso a WINE o ai suoi helper) venga aggiornato fin dalla sua prima scrittura.
Obiettivo della settimana: versione finale del capitolo della Guida, che include tutti gli aggiornamenti richiesti.
*** Settimana 12 (30/11-5/12): completamento del progetto
In accordo con i mentor del progetto, controllerò il capitolo del manuale nel controllo del codice sorgente, assemblerò il report del progetto e invierò il progetto come completato.