Ayuda:Tipos de contenidos

Esto es solo un borrador en proceso de edición, las normas de edición de este sitio aún están por definir (aunque las antiguas han quedado abolidas). Por favor, no edites esta página, cualquier comentario, crítica o sugerencia, hazla en la página de discusión.

Diversidad de contenidos

Este es un proyecto de documentación de amplio espectro, la diversidad de las temáticas y la diversidad en las maneras de exponer la información es tal, que es imposible establecer un único modelo de documento que sea válido en todas las circunstancias.

Es importante que al crear un documento nuevo tengas claro qué tipo va a ser. Del mismo modo, cuando edites un documento existente debes tener presente qué tipo de documento es.

Tipos de documentos

Artículo enciclopédico

Son semejantes a las entradas de la wikipedia. Sus características principales son:

• Ocupan una sola página.
• Tienen un nombre simple. la página sobre 'la cosa' se titulará 'cosa'. Por ejemplo, la página del gestor de arranque de Ubuntu, el GNU GRUB, se llamará GRUB
• Su contenido debe explicar qué es la cosa, cómo es la cosa y, en general, toda la información útil par que el lector conozca 'la cosa', además de enlaces para profundizar en la materia.
  • No debe ser un manual de uso de 'la cosa', aunque pueda o deba tener un enlace a uno.

Introducciones

Una 'introducción a...' Es un documento en el que se da una explicación básica general sobre un tema de forma que sea útil para usuarios sin conocimientos sobre el tema.

Guías

Son explicaciones paso a paso que guían al lector hacia un objetivo. Por ejemplo: Guía de instalación de Ubuntu 11.10- explicaría paso a pasa la instalación estándar de ubuntu 11.10.

Cómos

Son documentos finalistas sobre cómo conseguir tal objetivo. Se diferencian de las guías en que no son paso a paso, ni se centran en un único camino. Por ejemplo: Cómo instalar Ubuntu 11.10 - trataría sobre los distintos métodos de instalación de Ubuntu 11.10.

Manuales

Son recopilaciones de conocimiento no finalista sobre un tema.

Artículos "de autor"

doc.ubuntu-es tiene unas políticas, normas de edición y de estilos. Si bien en condiciones normales esto es positivo y necesario, toda norma tiene sus excepciones. Por otro lado, no queremos que estas normas restrinjan la creatividad de los editores.

Próximamente se creará una sección -namespace- especial en la que los editores podrán publicar contenidos que no cumplan las normas.

Por ejemplo, tenemos una política que exige que los contenidos sean neutrales. Es esta sección "de autor" podrán publicarse contenidos subjetivos en los que los editores puedan explicar los temas desde su punto de vista personal.

Profundidad de los documentos

doc.ubuntu-es pretende ser útil para todos los usuarios, algunos pueden ser expertos, otros pueden ser principiantes. No es factible crear un documento sobre un tema que sea práctico para todos. Por ello, al crear un documento tienes que tener claro a qué perfil de usuario va dirigido. Estos perfiles pueden ser cuatro:

• 0 - Usuarios sin conocimientos previos
  • Una introducción a Firefox explicaría lo más básico, como ver páginas, manejar pestañas, los marcadores...
• 1 -Usuarios con conocimientos medios
  • Un manual para Firefox de nivel medio explicaría con bastante detalle todas las funcionalidades principales del programa
• 2 -Usuarios con conocimientos avanzados
  • Un manual para Firefox de nivel avanzado explicaría con todo detalle todas las funcionalidades del programa excepto las más básicas, que se dan por supuestas
• 3 - Hackers (en el buen sentido)
  • Un 'Hackeando firefox' debe explicar cómo meterle mano al código del programa, cómo crear extensiones y complementos, programación con XUL...

Namespaces

El hecho de que Ubuntu publique una nueva versión cada 6 meses, que suele tener versiones nuevas de muchos programas, dificulta la creación de artículos de este tipo que sean útiles para todos los usuarios sin resultar farragosos, al contener información sobre todas la versiones. Para solucionar este problema, en doc.ubuntu-es, cada versión tiene su propio namespaces.

Por lo tanto, 'la cosa' debería tener los siguientes artículos enciclopédicos:

• Cosa : en el namespaces principal, debe contener una descripción general independiente de cualquier versión específica.
• 11.04:Cosa ; en el namespaces 11.04, debe contener una descripción específica de la cosa en esa versión concreta de ubuntu
• 11.10:Cosa ; en el namespaces 11.10...

De esta forma el usuario puede escoger si consulta la información general sobre 'la cosa', o la específica de la versión de Ubuntu que usa.