3.1 Métodos de trabalho DOC-BR

O DOC-BR assume o método de trabalho indicado pelo Projeto de Documentação do FreeBSD, e possui ainda características próprias de trabalho. De forma geral todo trabalho é diretamente realizado por editores de texto que podem ser dos mais simples, como vi(1) e ee(1), à editores mais completos com vim(8) e emacs(8). O FDP aconselha uso do emacs(8), em especial por ele ter suporte à modo de operação SGML — o chamado SGML-mode. Muitos dos nossos membros preferem usar editores da base como vi(1) ou ee(1).

Você pode escolher como quer trabalhar. O fato é, você deve optar pelo editor de texto o qual tem mais aptidão e fica mais confortável para trabalhar. O trabalho é grande e não muito simples, então o editor de texto não precisa ser algo a mais à aprender ou adaptar-se.

O Projeto de Documentação em Português Brasileiro do FreeBSD dispõe de scripts e arquivos de configurações para auxiliar o trabalho do tradutor. Portanto seja qual for sua opção de editor de texto, terá ferramentas para auxiliá-lo. Complementarmente o time criou também um script em linguagem Perl que analisa o arquivo XML e revisa algumas das principais regras do FDP. Por exemplo, você viu ao ler o Primer do Projeto de Documentação do FreeBSD que a identação das colunas deve seguir 2 caracteres de espaço. Que cada oito espaços devem ser substituídos por um \t (tab). Que o final de uma sentença deve ser denotado com dois espaços se não houver quebra de linhas ou final de parágrafo, que as linhas devem acabar no máximo na coluna 84 ou preferencialmente antes da coluna 70, etc. O script corrige todas as regras que ele for capaz e dispara um alerta para as regras que não conseguir corrigir.

Outra ferramenta que o contribuidor do DOC-BR deve ter noções básicas é o Subversion (svn). Nosso projeto faz uso de um repositório svn para armazenar e possibilitar o trabalho paralelo das dezenas de membros simultaneamente. As vantagens do uso do svn é ter um controle rígido sobre versões, podendo restaurar um arquivo erroneamente modificado à qualquer momento, e possibilitar trabalho concorrente de diversos indivíduos. A desvantagem é que é algo mais à se aprender, caso você não tenha familiaridade com essa ferramenta.

Por último, o método de comunicação entre todos os membros do DOC-BR é através de correio eletrônico, especificamente a lista de discussão DOC disponível na FUG-BR. Saiba como participar da lista na seção seguinte deste documento.