14.2. Diretrizes

Para promover a consistência entre os inúmeros autores da documentação do FreeBSD, algumas diretrizes foram elaboradas para os autores seguirem.

Use a Ortografia do Inglês Americano

Existem várias variantes do inglês, com grafias diferentes para a mesma palavra. Onde as grafias diferem, use a variante do inglês americano. color, não colour, rationalize, não rationalise, e assim por diante.

Nota:

O uso do inglês britânico pode ser aceito no caso de um artigo contribuído, no entanto, a ortografia deve ser consistente em todo o documento. Os outros documentos, como livros, site, páginas de manual, etc., terão que usar o inglês americano.

Não use contrações

Não use contrações. Sempre soletre a frase na íntegra. Do not é a forma correta, Don't é a errada.

Evitar contrações contribui para um tom mais formal, é mais preciso e é um pouco mais fácil para os tradutores.

Use a vírgula serial

Em uma lista de itens dentro de um parágrafo, separe cada item dos outros com uma vírgula. Separe o último item dos outros com uma vírgula e a letra e.

Por exemplo:

Esta é uma lista de um, dois e três itens.

É uma lista de três itens, um, dois e três, ou uma lista de dois itens, um e dois e três?

É melhor ser explícito e incluir uma vírgula serial:

Esta é uma lista de um, dois, e três itens.

Evite frases redundantes

Não use frases redundantes. Em particular, o comando, o arquivo e o comando man são frequentemente redundantes.

Por exemplo, comandos:

Errado: Use o comando svn para atualizar o código fonte.

Correto: Use o svn para atualizar o código fonte.

Nomes de arquivo:

Errado:… no nome do arquivo /etc/rc.local

Correto:… no /etc/rc.local

Referências de páginas de manual (o segundo exemplo usa citerefentry com a entidade &man.csh.1;):.

Errado: Veja man csh para mais informações.

Correto: Veja csh(1).

Dois espaços entre frases

Sempre use dois espaços entre as sentenças, pois isso melhora a legibilidade e facilita o uso de ferramentas como o Emacs.

Um período e espaços seguidos por uma letra maiúscula nem sempre marcam uma nova sentença, especialmente em nomes. Jordan K. Hubbard é um bom exemplo. Ele tem um capital H após um período e um espaço, e certamente não é uma nova sentença.

Para mais informações sobre o estilo de escrita, consulte Elementos de Estilo, de William Strunk.

All FreeBSD documents are available for download at https://download.freebsd.org/ftp/doc/

Questions that are not answered by the documentation may be sent to <freebsd-questions@FreeBSD.org>.
Send questions about this document to <freebsd-doc@FreeBSD.org>.