| Projeto de Documentação do FreeBSD em Português Brasileiro | ||
|---|---|---|
| Anterior | Capítulo 2. Projeto DOC-BR internamente | |
Estas regras são um resumo do Primer do Projeto de Documentação do FreeBSD. Para cumpri-las como já vimos existem ferramentas no Projeto DOC-BR que nos auxiliam, mas caso alguém esteja esquecido delas no Primer do Projeto de Documentação do FreeBSD, aqui estão novamente.
Sempre substitua um conjunto de 8 espaços por um tab. Esta regra do Projeto é para evitar uso desnecessário de dados. Regra que existe em todo o Projeto FreeBSD, desde o sistema em sí até o Ports e FDP. O motivo é simples, 8 espaços e um tab tem a mesma disposição textual, mas 8 espaços ocupam 8 bytes enquanto um tab ocupa 1 byte.
Utilize sempre dois espaços após cada separador frasal.
Não utilize espaços depois da tag <para> e nem antes ou depois da tag </para>.
O parágrafo começa na mesma linha onde a tag <para> foi colocada.
Uma linha deve preferencialmente ter menos de 70 colunas, e obrigatóriamente menos de 84 colunas.
Quando um parágrafo for quebrado em várias linhas, as linhas que terminarem em palavras normais devem ter um espaço em branco no final, e as que terminarem em um separador frasal devem ter dois espaços.
As tags de mesmo tipo devem estar sempre no mesmo nível de identação.
Se as regras 1, 2, 3 e 4 não forem cumpridas o documento não é aceito no CVS do Projeto FreeBSD. Isso é uma verificação automática. As outras regras são sujeitas à análise e revisão humana.
Importante: Jamais, sob qualquer circunstância traduza nada com tradutores eletrônicos. Use-os se necessário apenas para consultas quanto à palavras independentes. Não use sequer para traduzir expressões sem antes consultar o resultado com o restante do time. Tradutores eletrônico nunca interpretam textos e contextos. Não há qualquer hipótese de seu resultado ser aceitável.
No passado contribuidores da DOC-BR chegaram a usar parágrafos inteiros como traduzidos eletrônicamente. O resultados é que estes textos tiveram que ser totalmente rescritos na revisão, e retraduzidos do inglês pois o resultado em português raramente podia ser compreendido dentro do contexto desejado. Isso gera retrabalho, desperdiça o tempo do tradutor e do revisor.
Qualquer dúvida durante o trabalho, não pense duas vezes, pergunte ao restante do time na lista.
Este, e outros documentos, podem ser obtidos em ftp://ftp.FreeBSD.org/pub/FreeBSD/doc/.
Para perguntas sobre FreeBSD, leia a documentação antes de contatar <questions@FreeBSD.org>.
Para perguntas sobre esta documentação, envie e-mail para <doc@FreeBSD.org>.