Esta página contém os detalhes de um projeto de escrita técnica aceito para a temporada de documentos do Google.
Resumo do projeto
- Organização de código aberto:
- O projeto FreeBSD
- Redator técnico:
- quafena
- Nome do projeto:
- Criar um capítulo do manual do Wine
- Duração do projeto:
- Duração padrão (3 meses)
Project description
Como parte dessa iniciativa, eu produziria um capítulo aprofundado e com tamanho de guia do Manual do FreeBSD relacionado à instalação, ao uso e à solução de problemas do WINE (www.winehq.org) no FreeBSD. Meu objetivo é dedicar de quatro a oito horas por semana trabalhando nos itens abaixo, a menos que indicado de outra forma.
*** Vínculo comunitário
Se eu selecionasse o programa, passaria o período de vínculo comunitário 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 propôs, e me comprometo com os membros da equipe do projeto em relação ao fluxo de trabalho. Eu também entraria e navegaria por fóruns orientados a usuários para ter uma noção do que ajudaria os usuários do FreeBSD em relação à documentação em geral e ajudaria a trabalhar especificamente com o WINE no FreeBSD.
Eu passaria um tempo durante esse período aprendendo o conjunto de ferramentas da documentação do projeto. Isso me permitirá começar a trabalhar durante as primeiras semanas do projeto se for selecionado.
*** Semana 1 (14 a 19/09): instalações de teste e solução de problemas
Eu passaria a primeira semana da fase de desenvolvimento de documentos realizando uma instalação de teste do WINE na versão estável atual do FreeBSD, bem como instalando e executando uma variedade de aplicativos do Windows, desde utilitários simples até aplicativos mais complexos. Esta é uma abordagem que criei em um artigo semelhante sobre o ReactOS para MakeUseOf (https://www.makeuseof.com/tag/reactos-open-source-windows-clone/). Eu usaria o tempo da primeira semana para examinar uma seleção mais ampla de programas.
De acordo com minha experiência, esse tempo no início é útil para identificar e solucionar problemas gerais. Dessa forma, eu poderia ter as soluções em mãos na hora de escrever as seções relevantes ou, pelo menos, ter solicitações de assistência 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): documentando a instalação do WINE
Durante a semana 2, eu elaboraria as seções que ilustram a instalação do WINE por meio de métodos conhecidos, incluindo:
- Da origem usando o sistema de portas.
- Por pacotes binários usando repositórios principais.
- Como usar gerenciadores de pacotes da GUI disponíveis, se disponíveis
- De repositórios alternativos, como FreshPorts (e por que um usuário faria isso).
É importante nesta seção uma discussão sobre instalações simultâneas e de 32 bits em comparação a 64 bits, a fim de destacar as etapas extras necessárias para executar programas de diferentes arquiteturas.
Meta da semana:uma versão de rascunho polida das seções que descrevem a instalação do WINE no FreeBSD. Esse "rascunho" precisa incluir um texto quase final (revisão pendente e feedback de revisão) e marcadores de posição para capturas de tela, se não as próprias capturas de tela.
*** Semana 3 (28/09 a 02/09): como executar seu primeiro programa da WINE no FreeBSD
Depois que o subsistema WINE estiver instalado, a próxima seção detalha a instalação e a execução de alguns programas iniciais. Eles provavelmente se concentrariam em utilitários simples e autônomos, como o Notepad++ de código aberto. O objetivo é permitir que os usuários façam o download rapidamente de um aplicativo, o instalem e o vejam funcionando com o mínimo de transtorno.
Esta seção é importante para demonstrar aos usuários que alguns/muitos aplicativos do Windows podem ser executados no FreeBSD, o que o torna uma escolha viável para a computação diária.
Meta da semana:a identificação de um pequeno número de programas que são instalados de forma limpa e (em grande parte) prontos para uso, além de uma versão de rascunho sofisticada das seções que ilustram a instalação.
*** Semana 4 (5 a 9 de outubro): visão geral e conceitos do Vinho
O final da seção anterior faz alusão à necessidade de ajustes e personalizações para que determinados aplicativos funcionem no WINE. Nesse ponto, uma introdução ao subsistema WINE é útil para fornecer contexto. Estas seções examinariam o que acompanha o sistema WINE, como ele interage com o FreeBSD e onde o usuário pode começar a procurar entender melhor o sistema ou resolver problemas.
É importante observar que esta seção não tem como objetivo duplicar os recursos, mas sim apresentar uma visão geral organizada com links para outras fontes fáceis de entender para mais informações.
Meta da semana:um rascunho refinado das seções que apresentam o subsistema WINE aos usuários.
*** Semana 5 (12/10 a 16): configuração do WINE no FreeBSD
Estas seções apresentarão detalhes da configuração real do WINE, começando com modificações gerais/ajustes específicos do FreeBSD. Eles também ilustrariam o uso de pastas $WINEPLACE, que podem ser usadas para personalizar o ambiente WINE de um aplicativo específico. Como já existem recursos que explicam esse conceito mais detalhadamente, esta seção forneceria apenas uma introdução moderadamente detalhada antes de criar um link para eles.
Metas da semana:um rascunho refinado das seções que detalha onde, como e sob quais circunstâncias uma configuração detalhada do WINE é necessária.
*** Semana 6 (19/10 a 23): GUIs 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. Esta(s) seção(ões) fornece uma visão geral da instalação e do uso de algumas das opções que existem no FreeBSD, incluindo:
- WINECFG
- Winetrics
- Playonbsd
- outras disponíveis
Meta da semana:fornecer seções de rascunho aprimoradas com instruções sobre como instalar e usar o maior número possível dos aplicativos auxiliares de GUI WINE mais conhecidos.
*** Semana 7 (26/10-30): Perguntas frequentes sobre a WINE/FreeBSD (pesquisa)
Algumas das informações mais valiosas em relação a 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 respondem. Isso poupará muito tempo dos usuários se algumas dessas perguntas frequentes, especialmente aquelas que são conhecidas por afetar os usuários do FreeBSD, forem reunidas em um só lugar.
Estas seções têm o objetivo de fazer exatamente isso. Esta semana, eu pesquisaria os tipos de problemas que os usuários do FreeBSD geralmente têm com a WINE, além de procurar e, na medida do possível, testar as respostas. Assim, os leitores desse capítulo do Manual terão muito mais chances de resolver rapidamente um problema específico.
Essa(s) seção(ões) também incluiriam uma lista de recursos sobre onde procurar respostas que não foram fornecidas.
Meta da semana:refinar as seções de rascunho que contêm os problemas mais comuns do WINE, seja pela experiência dos usuários do FreeBSD ou em geral, e links/notas sobre as soluções. Embora o trabalho desta semana não tenha um resultado de rascunho, é provável que precise de mais tempo para encontrar e reconciliar problemas comuns, bem como rastrear as soluções. Esperaria gastar mais de 8 a 10 horas nesta pesquisa.
*** Semana 8 (02/11-6): Perguntas frequentes sobre a WINE/FreeBSD
Esta semana seria dedicada a sintetizar a pesquisa da Semana 7 para criar as seções sobre perguntas frequentes/problemas comuns na solução de problemas (com links para as soluções conforme apropriado).
Meta da semana:um rascunho refinado das seções com uma lista de perguntas frequentes e problemas frequentes e instruções passo a passo para resolvê-los.
*** Semana 9 (9 a 13 de novembro): administração do WINE multiusuário
Esta(s) seção(ões) oferecem orientações para administradores que querem implantar o WINE em um cenário multiusuário. Isso incluiria não apenas práticas recomendadas para compartilhar o próprio subsistema entre vários usuários, mas também em relação aos aplicativos Windows implantados no WINE.
Meta da semana: uma(s) seção(ões) de rascunho refinada(s) detalhando as orientações e práticas recomendadas para que os administradores do FreeBSD implantem aplicativos baseados em WINE e WINE para vários usuários.
*** Semana 10 (16/11 a 20): anexos, feedback de revisão e administração
Eu me esforço para implementar os feedbacks recebidos dos mentores e de outros revisores durante o processo de elaboração, mas esta semana daria tempo para uma reorganização/reescrita mais extensa, se necessário.
Além disso, escrevo qualquer administração necessária para este capítulo do Manual (fase direta, índices etc.) durante esse período, assim como montaria leituras adicionais relacionadas ao Vinho (por exemplo, usar a versão para Linux do WINE por meio da compatibilidade binária, o DOSBox para jogos/programas antigos etc.).
Meta da semana:um rascunho sofisticado de todo o capítulo do manual, incluindo todas as outras seções.
*** Semana 11 (23 a 27/11): finalização dos capítulos do manual
Eu planejaria dedicar esta segunda semana à última semana para revisar todo o texto, verificar imagens e testar as várias saídas (HTML, PDF etc.), conforme necessário. Esta semana também permitirá atualizações no caso de algum software acima (do próprio FreeBSD para o WINE ou seus auxiliares) fazer upgrade no tempo desde a criação inicial.
Meta da semana:versão final do capítulo do manual, incluindo todas as atualizações necessárias.
*** Semana 12 (30/11-12/5): finalização do projeto
De acordo com os mentores do projeto, eu verificaria o capítulo "Manual" no controle de origem, elaboraria o relatório do projeto e o enviaria como concluído.