3.6 Sugestões gerais para revisão de documentos

1. Lembre-se, sistemas, programas e arquivos não são pessoas então em geral não possuem gênero. Portanto evite artigos antes dessas expressões sempre que possível, em especial antes da palavra FreeBSD.

   Por exemplo:

   Exemplo 3-5. Exemplo 1 de expressões com artigo e gênero

   Bem vindo às Perguntas mais frequentes da série 2.X até a 4.X para o FreeBSD!

   Poderia ser:

   Exemplo 3-6. Exemplo 2 de expressões com artigo e gênero

   Bem vindo às Perguntas mais frequentes da série 2.X até 4.X para FreeBSD!

   Nesse caso evitamos o artigo quanto à versão do sistema operacional e o gênero do FreeBSD. Poderia ser ainda mais simples (em geral, quanto mais simples melhor):

   Exemplo 3-7. Exemplo 3 de expressões com artigo e gênero

   Bem vindo às Perguntas mais frequentes para as versões 2.X á 4.X do FreeBSD!

   Nesse caso evitamos todos os artigos e gêneros possíveis antes das expressões mencionadas, tornando o texto mais simples e claro de ser lido. Mantivemos o que é essencial para o contexto. As três frases dizem exatamente a mesma coisa.

2. Depois de separador frasal, use dois espaços e não apenas um. Isso ajuda quem utiliza o emacs(8) e também facilita a percepção de término de frase para o compilador/interpretador que fará as normalizações e conversões SGML. Isso se deve ao fato de que nem sempre separadores frasais mais comuns, como ponto e vírgula (;) e ponto final (.) aparecem no término de frases. Por exemplo:

   Exemplo 3-8. Exemplo de separador frasal fora de término de sentença

   O criador do UFS é Marshall K. McKusick. McKusick projetou também o UFS2 no FreeBSD e participou ativamente da reimplementação deste sistema de arquivos em sua segunda encarnação.

   Está claro que o separador frasal ponto (.) nesse caso tem funções completamente distintas em “Marshall K.” de “McKusick.” ou “encarnação.”. Contudo para uma máquina essa distinção não existe.

3. Acrônimos também não tem gênero. Por exemplo, não há porque ter dúvidas entre "a FAQ" ou "o FAQ"; FAQ não é menino nem menina, portanto é apenas FAQ.

4. Expressões que não podem ser traduzidas mas não são técnicas devem ser identificadas como expressão em língua estrangeira, para tal ela deve ficar entre <foreignphrase></foreignphrase>. Caso a expressão seja um termo consagrado em qualquer língua como kernel, FAQ, SPAM ou home, estas devem ser consideradas literais. FAQ, SPAM, kernel ou home significam a mesma coisa em qualquer língua, todos entendem. Portanto ficam em <literal></literal>.

   Expressões consagradas no Projeto também devem ser consideradas literais. Por exemplo, port, ports, Core Team, RELEASE não são fácilmente perceptíveis em qualquer língua, mas se o leitor conhece FreeBSD, em qualquer língua saberá à o que estas se referem. Portanto usaremos sempre <literal>ports</literal>, <literal>port</literal>, <literal>RELEASE</literal>, etc.