Proyecto:Normas de edición

De doc.ubuntu-es
Revisión a fecha de 18:35 21 jun 2012; Eugenio A. González Benito (Discusión | contribuciones)

(dif) ← Revisión anterior | Revisión actual (dif) | Revisión siguiente → (dif)
Saltar a: navegación, buscar

Normas de edición

Este documento forma parte de las políticas y normas de este sitio, por ello, es de obligado cumplimiento por todos los editores (véanse #Excepciones).


Antes de crear páginas nuevas

  1. Asegúrate de tener claro qué tipo de página quieres crear.
  2. Verifica que no existe ya algo como lo que quieres hacer.
    1. Si ya existe, consulta en la sub-página de discusión las normas de edición antes de empezar a editarla, si ves que tiene un autor o un responsable, u otros editores, ponte en contacto con ellos para coordinar el trabajo de mejora de esa página.
    2. Si esa página no tiene autor declarado ni responsable, o ves que éstos no mantienen actualizada la página, puedes auto-proponerte para asumir la responsabilidad de la edición y mantenimiento de esa página, o simplemente empezar a editarla.


Crear una página nueva

  1. Si no existe algo como lo que quieres hacer, piensa bien el título que le pondrás, dependiendo del tipo de página, ésta puede ser una decisión importante.
  2. Escoge bien el namespace apropiado para el tipo de contenido que quieres incluir.
  3. Una vez creada la página, puedes empezar a editarla, procura hacerlo siguiendo las normas de estilo y edición.
  4. Crea lo antes posible la sub-página de discusión, en ellas debes indicar el tipo de documento que pretendes crear, la licencia, y demás información de interés.
  5. Debes incluir la página en, al menos, una categoría.


El nombre a las páginas

Utiliza títulos siempre en minúscula (incluso las letras capitales, a no ser que sean nombres propios - por ej. Linux, GNOME...). La Primera letra del título puede ir en mayúsculas (de hecho MediaWiki siempre la creará en mayúsculas y no hará diferencias en los enlaces, en cambio el resto si hará diferencia). Puedes utilizar tildes y "ñ", pero no uses otro tipo de caracteres extraños.


Categorías

Todas las páginas de documentación deben pertenecer al menos a una categoría, lo idóneo es incluirla en varias. Véase Ayuda:Cómo categorizar

En este wiki tenemos dos tipos de categorías: Las informativas y las internas.

Las informativas
Sirven para organizar los contenidos y ayudar al lector a localizar páginas relacionadas.
Deben incluirse en el propio documento
Las internas
Sirven para informar del estado o tipo de los contenidos, ayudan a los editores a organizar su trabajo.
Deben incluirse en la página de discusión del documento.


La página de discusión

Todas las páginas de documentación deben tener su correspondiente página de discusión. Véase Ayuda:La página de discusión.


Escribiendo una página

  • La documentación debe ser modular, es decir, no crees páginas extensas con documentación muy específica para un tema muy amplio. Es mejor crear páginas que puedan hacer un poco de índice, que incluyan documentación básica y sencilla (lo imprescindible para usuarios noveles) con enlaces a páginas específicas para quien realmente quiera profundizar. Hay que tener en cuenta que esta guía pretende llegar a varios tipos de usuarios, si incluimos de primeras información muy técnica, muchos usuarios nuevos se asustarán y pensarán que esta documentación es solo para expertos. De la otra manera, quien quiera profundizar podrá hacerlo y quien quiera solo saber lo básico no tendrá que escarbar entre miles de tecnicismos.


Enlaces

Todas las páginas deben contener enlaces a otras páginas. Estos enlaces pueden ser internos -a otras páginas del wiki- o externos -a otros sitios web-.

Han de usarse preferentemente enlaces internos, aunque la página no exista. Solo deben usarse enlacen externos en los siguientes casos:

  • Si no existe la página en el wiki, en vez de un enlace rojo puede usares un enlace externo solo si la información enlazada es imprescindible.
  • Si para crear el documento nos hemos basado en una fuente externa debe incluirse un enlace a ésta.


Fuentes

  • Pon siempre la fuente de donde has sacado tu información. No utilices fuentes con copyright sin permiso expreso del autor y respeta siempre las licencias de las fuentes (consulta Licencias). Lo ideal es utilizar fuentes que tengan una licencia como mínimo tan libre como la nuestra (ver la licencia del wiki).


Material de terceros

  • No es necesario reescribir la información. Por suerte Internet está llena de documentación fiable y de calidad: tradúcela, cópiala (siempre que su licencia lo permita), modifícala, reestructúrala o actualízala.


Multimedia

Se recomienda añadir imágenes a los artículos, como suele decirse, una imagen vale más que mil palabras, pero...

  • Hazlo con moderación.
  • Procura usar imágenes que ya estén presentes subidas al wiki.
  • Si no encuentras la imagen que necesitas, si puedes créala y súbela al wiki.
  • Si no puedes/sabes crearla, busca una que tenga una licencia libre y súbela al wiki.


El título de las páginas

Esta página contiene las normas y pautas a seguir a la hora de ponerle nombre a una página nueva.

Hemos de tener mucho cuidado al escoger el nombre de una página nueva por dos razones.

  1. Escoger el nombre apropiado no siempre es fácil, son bastantes los aspectos a tener en cuenta.
  2. Si nos equivocamos en el contenido de una página, corregirlo es muy fácil. Si le damos a una página un nombre equivocado, corregirlo no es tan fácil.

Preferiblemente en español

Debemos usar preferentemente nombres en español. Pero no podemos ni debemos negar la realidad, en la terminología informática usada por los hispano-parlantes abundan los anglicismos, no debemos empeñarnos en traducir palabras habituales en el vocabulario de nuestros lectores, como pueden ser: router, root...

Singular

Deben usarse preferentemente las formas en singular, por ejemplo: Copia de seguridad. Aunque caben las siguientes excepciones:

  • Nombres de clases de cosas: Navegadores
  • Categorías que aglutinan un listado de nombres: [[Categoría:Comandos]]

Siglas y acrónimos

En principio, debe evitarse su uso, salvo cuando éste sea el nombre habitual de la cosa, por ejemplo: APT

Caracteres Permitidos

En principio, se puede usar el repertorio completo de caracteres UTF-8, con las siguientes excepciones:

  • # < > [ ] | { }
  • los caracteres invisibles de control (códigos ASCII 0-31)
  • el DELETE (código ASCII 127)
  • La barra inclinada (/) no debería usarse.

Excepciones

(pendiente de edición)

Herramientas personales