Guía de estilo

Para mostrar la documentación de forma organizada, estandarizada y fácil de leer, la guía de estilos de MDN describe cómo debe organizarse, escribirse y formatearse el texto. Se trata de pautas más que de reglas estrictas. Interesa más el contenido que el formato, así que no te sientas obligado a aprenderte la guía de estilos antes de colaborar. No te enojes ni te sorprendas si después un voluntario edita tu trabajo para que quede de acuerdo con esta guía.

Los aspectos lingüísticos de esta guía se refieren principalmente a la documentación en idioma inglés.Se pueden (y se anima a) crear guías de estilo en otros idiomas. Estas deben publicarse como subpáginas de la página del equipo de localización.

Si buscas especificaciones de cómo debe estructurarse un determinado tipo de página, mira la guía de diseño de MDN.

Aquí se enumeran los usos y costumbres recomendados a la hora de editar los artículos de este wiki. Si ves que falta contenido o crees que deberíamos mejorar o corregir algo, por favor coméntalo en la página de discusión.

Uso de mayúsculas en el nombre de las páginas y los encabezados

  • Cuando escribas los nombres de las páginas y de los encabezados, recuerda que sólo debe empezar con mayúscula la primera palabra de la frase.

    • Correcto: "Guía de estilo"
    • Incorrecto: "Guía de Estilo"

Infinitivos y gerundios

  • En inglés, una práctica muy habitual es la de utilizar verbos acabados en "-ing" en los títulos: "Configuring Firefox", por ejemplo. En estos casos la traducción correcta al español consiste en utilizar el infinitivo del verbo y no el gerundio.

    • Correcto: Configurar Firefox
    • Incorrecto: Configurando Firefox

Siglas y abreviaturas

Mayúsculas y espacios

  • Escribe las siglas en mayúsculas y sin puntos.

    • Correcto: XUL
    • Incorrecto: X.U.L.; Xul

Expansión

  • Siempre que sea posible, cuando uses siglas deberás expandirlas, es decir, explicar su significado. Recuerda que esto es necesario sólo la primera vez que dicha sigla aparezca en tu artículo.

    • Correcto: "SVG (Gráficos vectoriales escalables) es un lenguaje de marcado XML..."
    • Incorrecto: "SVG es un lenguaje de marcado XML..."

  • También existe la opción de usar el elemento abbr:

    • El siguiente código: <abbr title='Gráficos vectoriales escalables'>SVG</abbr>
    • Se muestra de la siguiente forma: SVG

Plurales

  • Para indicar el plural de una sigla usas "s".

    • Correcto: CD-ROMs
    • Incorrecto: CD-ROM's

Números

Fechas

  • Para las fechas usa el formato: día mes año.

    • Correcto: 1 de enero de 2006
    • Incorrecto: 01/02/06

Cantidades

  • Usa coma para separar los decimales y punto para indicar miles:

    • Correcto: 1,5 GB son 1.536 MB
    • Incorrecto: 1.5 GB son 1536 MB

Esta regla tiene una excepción: en un documento que trate del lenguaje 'X', las cantidades deben expresarse del modo definido por ese lenguaje.

Usted, tú y yo

El tuteo

Este es un problema complejo, puede que no exista la solución perfecta a gusto de todos. Pero sería interesante ponernos de acuerdo.

Por lo pronto, hemos decidido usar el tú y evitar regionalismos en nuestras traducciones. Te invitamos a comentar tus opiniones en nuestra lista de correo.

La 1ª persona

Salvo rarísimas excepciones, nunca debe usarse.

  • Correcto: es recomendable...
  • Incorrecto: te recomiendo...

Otras guías de estilo recomendadas

Si tienes dudas sobre usos y estilos que no sean tratados en este documento, te recomendamos consultar:

Los traductores también deberían consultar Writer's guide para conocer el estilo usado en la edición inglesa.

Diccionarios recomendados

Si tienes dudas sobre gramática y ortografía, puedes visitar: