Introducción al FDP-es
Anterior |  | Siguiente

# 4. Guía de estilo

Esta sección están basada en la sección “writing style” del libro “fdp-primer” que puede consultarse en (http://www.es.FreeBSD.org/doc/en_US.ISO8859-1/books/fdp-primer/writing-style.html).

Es necesario intentar mantener la consistencia entre la multitud de autores que trabajan en la Documentación de FreeBSD, razón por la cual se han creado unas líneas generales. A esta búsqueda de la consistencia se opone también la variedad de orígenes de los traductores de la Documentación, por lo que se listan aquí unas cuantas normas que pueden ser de ayuda. Dado que la Documentación que va a traducir ya ha pasado por más de una mano experta puede usarla como plantilla para su traducción.

Idioma

- El idioma oficial del FDP-es es el castellano (o español de España), es_ES; la decisión de tener lengua oficial no es una idea exclusiva nuestra puesto que en el el Proyecto de Documentación de FreeBSD el idioma oficial es el inglés de los Estados Unidos de América (en_US). Se intenta evitar el uso de palabras “agresivas” con otros castellanoparlantes como `ordenador` (computador, computadora, sistema, máquina o incluso host) pero al iniciar los trabajos necesitaban una norma y lógicamente usaron la que la que más cerca tenían.

- Evite frases redundantes

  Intente evitar usar frases redundantes. Por ejemplo “el comando”, “el fichero” y “man comando” probablemente son redundantes.

  He aquí dos ejemplos en el caso de los comandos. El segundo ejemplo mostrado es el recomendable.

- Utilice el comando `cvsup` para actualizar sus fuentes

- Utilice `cvsup` para actualizar sus fuentes

Veamos dos ejemplos para nombres de ficheros. Recomendamos el uso del segundo ejemplo.

… en el fichero llamado `/etc/rc.local`…

… en `/etc/rc.local`…

Veamos un ejemplo sobre páginas man. Recomendamos el uso del segundo caso, que usa `<citerefentry>`.

Para más información consulte `man csh`.

Consulte csh(1)

Dos espacios al final de cada frase

  Deje siempre dos espacios al final de cada frase. El texto será más legible y se facilita el uso de herramientas como Emacs.

  Puede pensarse que una mayúscula tras un punto indica nueva frase pero no siempre es así, sobre todo si se trata del nombre de algunas personas. “Jordan K. Hubbard” es un buen ejemplo de ello. Tiene una `H` mayúscula tras un punto y un espacio y es evidente que no es una nueva frase.

Anterior | Inicio | Siguiente
Cómo formar parte del FPD-es |  | Guía de sintaxis

Puede descargar éste y muchos otros documentos desde ftp://ftp.FreeBSD.org/pub/FreeBSD/doc/.

Si tiene dudas sobre FreeBSD consulte la documentación antes de escribir a la lista <questions@FreeBSD.org>.
Envíe sus preguntas sobre la documentación a <doc@FreeBSD.org>.