Esta página contém os detalhes de um projeto de redação técnica aceito para a Google Season of Docs.
Resumo do projeto
- Organização de código aberto:
- O Projeto FreeBSD
- Redator técnico:
- cafeína
- Nome do projeto:
- Criar um capítulo do manual sobre vinhos
- Duração do projeto:
- Duração padrão (três meses)
Project description
Como parte dessa iniciativa, eu produziria um capítulo detalhado do Guia do FreeBSD relacionado à instalação, uso e solução de problemas do WINE (www.winehq.org) no FreeBSD. Eu tentaria passar de 4 a 8 horas por semana trabalhando nos itens abaixo, a menos que indicado de outra forma.
*** Vinculação à comunidade
Se eu fosse selecionado, passaria o período de vinculação à comunidade me familiarizando com os processos e a infraestrutura de documentação do projeto FreeBSD. Sempre me impressionei com a documentação coesa que o projeto apresentou e interagi com os membros da equipe do projeto em relação ao fluxo de trabalho deles. Eu também entraria e navegaria por fóruns voltados ao usuário para ter uma noção do que ajudaria os usuários do FreeBSD em relação à documentação em geral, além de ajudar a trabalhar com o WinE no FreeBSD em particular.
Durante esse período, eu passaria um tempo aprendendo o conjunto de ferramentas de documentação do projeto. Isso me permitirá começar com o pé direito durante as primeiras semanas do projeto se eu for selecionado.
*** Semana 1 (14 a 19 de setembro): instalação de testes e solução de problemas
Eu passaria a primeira semana da fase de desenvolvimento de documentos executando uma instalação simulada do WINE na versão estável atual do FreeBSD, além de instalar e executar vários aplicativos do Windows, desde utilitários simples até aplicativos mais complexos. Essa é uma abordagem que usei em um artigo semelhante que fiz sobre o ReactOS para o MakeUseOf (https://www.makeuseof.com/tag/reactos-open-source-windows-clone/), só que eu usaria o tempo da primeira semana para examinar uma seleção mais ampla de programas.
Na minha experiência, passar esse tempo antes é útil para identificar e resolver problemas gerais. Dessa forma, eu poderia ter as soluções em mãos quando fosse a hora de escrever seções relevantes ou, pelo menos, fazer solicitações de ajuda para os canais apropriados.
Meta da semana:ter um resumo dos capítulos de instalação e os detalhes necessários sobre como corrigir problemas comuns de instalação.
*** Semana 2 (21 a 25 de setembro): documentação da instalação do WinE
Durante a segunda semana, eu redigi as seções que ilustram a instalação do WINE por métodos conhecidos, incluindo:
- Da origem usando o sistema de portas;
- Por pacotes binários que usam repositórios principais;
- Usar gerenciadores de pacotes de GUI disponíveis, se disponíveis;
- De repositórios alternativos, como o FreshPorts (e por que um usuário faria isso).
É importante nesta seção uma discussão sobre instalações simultâneas e de 32 e 64 bits para destacar as etapas extras necessárias para executar programas de diferentes arquiteturas.
Objetivo da semana:uma versão de rascunho refinada das seções que descrevem a instalação do WinE no FreeBSD. Esse "rascunho polido" deve incluir o texto quase final (aguardando revisão e feedback) e marcadores de posição para capturas de tela, se não forem as capturas de tela.
*** Semana 3 (28/09 a 02/10): executar seu primeiro programa WINE no FreeBSD
Depois que o subsistema WINE for instalado, a próxima seção detalhará a instalação e a execução de alguns programas iniciais. Provavelmente, eles se concentrariam em utilitários simples e independentes, como o Notepad++ de código aberto. O objetivo é permitir que os usuários façam o download e a instalação de um aplicativo rapidamente e o vejam funcionando com o mínimo de problemas.
Esta seção é importante para demonstrar aos usuários que alguns ou muitos aplicativos do Windows podem ser executados no FreeBSD, tornando-o uma opção viável para computação diária.
Objetivo da semana: a identificação de um pequeno número de programas instalados de forma limpa e (em grande parte) prontos para uso, além de uma versão de rascunho das seções que ilustram a instalação.
*** Semana 4 (5-10/10): visão geral e conceitos do WinE
O final da seção anterior faz referência à necessidade de fazer alguns ajustes e personalizações para que determinados aplicativos funcionem no WINE. Nesse ponto, uma introdução ao subsistema WINE é útil para fornecer contexto. Essas seções examinam o que vem com o sistema WINE, como ele interage com o FreeBSD e onde um usuário pode começar a entender melhor o sistema ou resolver problemas.
O objetivo desta seção não é duplicar os recursos atuais, mas sim apresentar uma visão geral organizada com links para outras fontes de fácil compreensão para mais informações.
Meta da semana:um rascunho aprimorado das seções que apresentam o subsistema WINE aos usuários.
*** Semana 5 (12/10-16): configuração do WinE no FreeBSD
Essas seções aprofundam na configuração real do WINE, começando com modificações/ajustes gerais específicos para o FreeBSD. Eles também ilustram o uso de pastas $WINEPREFIX, que podem ser usadas para personalizar o ambiente WINE para um aplicativo específico. Como já existem recursos que explicam esse conceito em detalhes, esta seção só vai fornecer uma introdução moderadamente detalhada antes de vincular a eles.
Metas da semana:um rascunho aprimorado das seções que detalham onde, como e em quais circunstâncias a configuração detalhada do WINE é necessária.
*** Semana 6 (19 a 23 de outubro): GUIs do WINE no FreeBSD
Como configurar o WINE para executar um determinado programa pode ser um exercício complexo e demorado, existem ferramentas auxiliares para facilitar esse processo. Essas seções fornecem uma visão geral da instalação e do uso de algumas das opções disponíveis no FreeBSD, incluindo:
- WINECfg
- winetricks
- playonbsd
- outros como disponíveis
Objetivo da semana: fornecer seções de rascunho refinadas com instruções sobre como instalar e usar o maior número possível de aplicativos auxiliares GUI WinE populares.
*** Semana 7 (26/10 a 30/10): perguntas frequentes sobre WINE/FreeBSD (pesquisa)
Algumas das informações mais valiosas sobre aplicativos técnicos complexos, como o WINE, podem ser encontradas na interação entre usuários que tentam resolver problemas específicos e especialistas que fornecem respostas. Isso vai economizar muito tempo dos usuários se algumas dessas perguntas frequentes, principalmente aquelas que afetam os usuários do FreeBSD, forem coletadas em um só lugar.
O objetivo dessas seções é fazer exatamente isso. Vou passar esta semana pesquisando os tipos de problemas que os usuários do FreeBSD costumam ter com o WINE, além de procurar e (na medida do possível) testar as respostas. Isso vai dar aos leitores deste capítulo do Manual uma chance muito melhor de resolver rapidamente um problema específico.
Esta(s) seção(ões) também incluiria uma lista de recursos sobre onde procurar respostas que não foram fornecidas.
Meta da semana:seções de rascunho aprimoradas contendo os problemas mais comuns do WINE, como os usuários do FreeBSD ou em geral, e links/notas sobre as soluções. Observe que, embora o trabalho desta semana não tenha um rascunho de saída, ele provavelmente exigirá um investimento maior de tempo para encontrar e reconciliar problemas comuns, bem como rastrear suas soluções. Eu espero passar de 8 a 10 horas nessa pesquisa.
*** Semana 8 (02/11/206): perguntas frequentes sobre WinE/FreeBSD
Esta semana será usada para sintetizar a pesquisa da Semana 7 e criar as seções de perguntas frequentes/problemas comuns (com links para soluções, conforme apropriado).
Meta da semana:um rascunho aprimorado das seções com perguntas frequentes/problemas comuns e instruções detalhadas para resolvê-los.
*** Semana 9 (9 a 13 de novembro): administração de WINE para vários usuários
Esta(s) seção(ões) oferece(m) orientação para administradores que buscam implantar o WinE em um cenário multiusuário. Isso incluiria não apenas as práticas recomendadas para compartilhar o próprio subsistema entre vários usuários, mas também com relação aos aplicativos Windows implantados no WinE.
Meta da semana:uma seção de rascunho detalhada com orientações e práticas recomendadas para administradores do FreeBSD implantarem o WINE e aplicativos baseados no WINE para vários usuários.
*** Semana 10 (16 a 20 de novembro): apêndices, feedback de revisão e Administrivia
Embora eu me esforce para implementar qualquer feedback recebido de mentores e outros revisores durante o processo de redação, essa semana permitiria tempo para uma reorganização/reescrita mais extensa, se necessário.
Além disso, eu escrevo qualquer administração necessária para este capítulo do manual (fator, índices etc.) durante este período, bem como montei leituras adicionais relacionadas ao WinE (por exemplo, usando a versão Linux do WinE por meio de compatibilidade binária, DOSBox para jogos/programas antigos etc.).
Meta da semana:um rascunho aprimorado de todo o capítulo do Manual, incluindo todas as outras seções.
*** Semana 11 (23 a 27/11): finalização do capítulo do manual
Eu planejo dedicar esta penúltima semana para revisar todo o texto, verificar as imagens e testar as várias saídas (HTML, PDF etc.) conforme necessário. Essa semana também permite atualizações no caso de qualquer um dos softwares acima (do próprio FreeBSD para WINE ou seus auxiliares) ser atualizado desde a redação inicial.
Objetivo da semana: versão final do capítulo do manual, incluindo todas as atualizações necessárias.
*** Semana 12 (30/11 a 5 de dezembro): finalização do projeto
De acordo com os mentores do projeto, eu verificaria o capítulo do Manual no controle de origem, montaria o relatório do projeto e enviaria o projeto como concluído.