Ayuda:Estilo

Las personas encargadas de la edición de esta página consideran que aún necesario efectuar cambios, quizás importantes, en la misma.

El artículo está siendo traducido desde en:Help:Style y puede que contenga errores o que falte texto por traducir. También puede contener texto sin traducir.

Wiki > Lineamientos para el contenido

Concepto - Espacio de nombre - Edición - Estilo - Portal - Plantilla - Categoría - Ícono - Video - Página de referencia - Por hacer

Los lineamientos de estilo cubren lo esencial de cómo crear o editar artículos para asegurar una apariencia (look and feel) similar a lo largo del wiki. Ellos están basados en los lineamientos de Wikipedia. Los siguientes lineamientos incluyen información detallada sobre el estilo del wiki de openSUSE.

Usabilidad general

Estilo neutro

Usa un estilo de escritura neutro. Evita el uso de pronombres personales como "Yo", "Nosotros", entre otros.

Mantenerlo corto y conciso

Cuando escribas, considera cuán rápido decides continuar leyendo, o dejar de hacerlo. Escritura pobre y artículos con palabras de más no serán leídos.

• No agregar contenido irrelevante o redundante. Las personas leerán artículos cortos y claros, que proporcionen la información que necesitan. No obstante, le huirán a aquellos artículos con contenido irrelevante.
• Usa un formato consistente y ordenado desde el principio. Nadie leerá un artículo muy largo dividido en secciones con colores o diseños que no concuerdan. Eso sólo hace la lectura más lenta y sirve para alejar al lector.
• Para hacer un artículo útil y popular, ¡mantenlo corto y conciso!

Ver desarrollo de un artículo en Wikipedia.

---

Estructura

Título

• El título debería ser claro y corto. Ver Ayuda:Ejemplos de títulos incorrectos.
• No usar acrónimos, a menos que sean bien conocidos por la audiencia objetivo.
• No usar el estilo CamelCase. En su lugar usar espacios.
• Usar el mismo estilo de mayúsculas que Wikipedia.
• No usar dos puntos como separador en los títulos, ya que este método es usado para separar espacios de nombre por MediaWiki.
• Evitar el uso de caracteres especiales. Usar solamente los caracteres [0-9] [aA-zZ] y sus respectivos acentos.

Título de sección

• Todos los lineamientos arriba mostrados aplican también a títulos de sección.
• Debido a que los títulos de sección forman la tabla de contenido, un estilo corto ayuda a la fácil lectura y navegación de la página.
• No repetir el título del artículo en la primera sección. La redundancia no fomenta continuar con la lectura.
• No usar Acerca de o Introducción como nombre de la primera sección. La primera sección de cualquier artículo es la introducción de un tema, así que decirlo explícitamente no agrega nada nuevo al lector.

Encabezados

• Usar la etiqueta = para crear un encabezado. De esta forma, la tabla de contenido es generada automáticamente de los encabezados y esto ayuda a los lectores a ir directamente a la sección de interés.
• Siempre empezar con dobles signos igual ==. Nunca usar solamente uno: =.

El signo igual simple (=) produce el mismo tamaño de texto que el título del artículo, el cual no es usado comúnmente en ningún estilo de escritura.

• No colocar enlaces en los encabezados. En lugar, enlaza la palabra o frase la primera vez que aparece en la sección.
• Separar secciones muy largas en algunas subsecciones usando subencabezados.
• Usar la etiqueta ---- para crear un separador horizontal antes de cualquier encabezado de segundo nivel (==), ya que esto ayuda en la lectura del artículo.

Ejemplo:

 ==Encabezado 1==
 ===Encabezado 1.1===
 ===Encabezado 1.2===
 
 ==Encabezado 2==
 ===Encabezado 2.2===
 ====Encabezado 2.2.1====
 =====Encabezado 2.2.1.1=====

 ==Encabezado 3==

Contenido

Deletreo de openSUSE

• openSUSE es la única forma correcta de escribir openSUSE. "OpenSUSE", "openSuSE", OpenSuse" y otras variaciones están todas escritas incorrectamente. Debido a que el software MediaWiki no puede manejar títulos de páginas en minúsculas, usar la Plantilla:Título_en_minúscula cuando sea necesario escribir artículos cuyos títulos empiecen con letras minúsculas, como "eBay" o "iTunes".
• No usar caracteres de marcas (como © o ®) ya que esto impide la lectura del artículo.
• Notar que la escritura de "SuSE Linux" y "SUSE Linux" están obsoletas. A menos que se requiera hacer referencia a una versión antigua de openSUSE (10.1 y anteriores) para propósitos históricos de SUSE Linux Enterprise Server (SLES) o SUSE Linux Enterprise Desktop (SLED), usar siempre "openSUSE".

Duplicación

No duplicar esfuerzos.

• Verificar la lista de CÓMOs de openSUSE. Ya existe una gran colección de artículos. Si hay alguno que cubra el tema del cuál deseas escribir entonces tomate un tiempo para leerlo y ver si puedes mejorarlo.
• El foro de openSUSE tiene una colección de CÓMOs (en inglés).
• Hay también una gran colección de artículos CÓMO en The Linux Documentation Project, Proyecto de Documentación de Linux.

Acrónimos y abreviaciones

• Cuando introduces nuevos acrónimos en un artículo, usar el nombre completo la primera vez que aparece, seguido de la forma abreviada dentro de paréntesis. Por ejemplo: Tabla de Contenidos (TDC).
• Evitar abreviaciones complejas ya que ellas hacen los artículos más difíciles de leer.
• Siempre usar abreviaciones estándares y bien conocidas, ya que la innovación puede llevar a una mala interpretación.

Variables

Algunas veces, un comando de entrada es específico para el sistema del usuario, como system devices o username. Las siguientes convenciones deben ser usadas:

• <username>, por ejemplo para describir la ruta /home/<username>.
• sdX para describir dispositivos de almacenamiento; el punto es que la letra X está en mayúsculas y al realizar un copia-pega del comando se producirá un error de ejecución en lugar de algún daño al sistema.
• No olvidar decirle a tus lectores qué es lo que deben colocar envés de <username> o sdX. No todo el mundo está familiarizado con las convenciones de escritura aquí mencionadas.

Seguridad de los usuarios sin experiencias

Advertencia: Ser especialmente cuidadoso dando instrucciones que tienen que ser ejecutadas con privilegios de administrador. Los comandos como dd, rm o fdisk, pueden hacer mucho daño si se usan sin conocerlos. Los usuarios nuevos a menudo no entienden, sino que solamente copian y pegan el comando:

• Usar ejemplos de códigos que en caso de ser copiados y pegados directamente dentro de la interfaz de línea de comandos resultarán en un error de ejecución, no en un desastre.

Incorrecto:	# dd if=openSUSE-11.2-KDE4-LiveCD-i686.iso of=/dev/sda	El /dev/sda pertenece al primer disco duro y existe en cualquier computadora.
Correcto:	# dd if=openSUSE-11.2-KDE4-LiveCD-i686.iso of=/dev/sdX	El /dev/sdX no existe en instalaciones normales y dd devolverá un error sobre la no existencia de /dev/sdX .

Imágenes

Ubicación

Ver la sección de marco de la ayuda de imágenes para recomendaciones sobre el mejor marco a usar. Para ejemplos e ideas de cómo colocar imágenes, ver el tutorial de Wikipedia.

Formato

• Los dibujos, iconos y otras imágenes similares (básicamente aquellas con grandes, simples y continuos bloques de colores) deben estar en formato PNG.
• Las fotos deben estar en formato JPEG.
• Animaciones deben estar en formato GIF animado.

Es importante notar que versiones antiguas de los artículos no muestran la correspondiente versión antigua de la imagen, solamente las últimas versiones, a menos que hayan cambiado los nombres de los archivos de las imágenes.