Cómo usar este recurso

Bienvenido al centro de ayuda y documentación! Esta forma de generar documentación es algo distinta de la que quizás estés habituado a usar, así que por favor lee este documento para entender cómo colaborar y hacer tus aportaciones.

Inicio rápido

Para los impacientes, aquí tenéis lo más básico que deberíais saber:

• Tendrás que estar identificado.
• Hay diferentes tipos de documentación, la mayoría se entienden por ellos mismos, pero presta atención a las diferencias entre un How-to y un tutorial (explicadas mas adelante).
• Para agregar documentación o ayuda dirígete a la sección adecuada, asegúrate de que no exista ya una entrada referente al tema que quieres agregar y usa el botón de la parte inferior derecha (normalmente pondrá 'Agregar FAQ' o similar).
• Agrega tu contenido, y guárdalo. El ciclo de editar/visualizar el contenido puede realizarse tantas veces como desees hasta estar satisfecho con el contenido.
• Asegúrate de enviar tu documento para publicación cuando hayas terminado - desplegable de la parte superior derecha en la área de contenidos.
• Tu documento será revisado y publicado a no ser de que sea necesario mejorarlo.
• Si después alguien agrega comentarios a tu entrada, se te notificará por correo electrónico.

¿Qué tipo de elemento es mi documentación?

Seguidamente encontrareis una descripción, uso y ejemplo para cada tipo:

Preguntas Frequentes (FAQ)

Una FAQ es una pregunta corta, que se puede responder en 1 o 2 parágrafos. Puedes agregar varias preguntas en una área de FAQ y agruparlas en secciones:

    Ejemplo de FAQ
    Pregunta: Qué es Plone?

    Respuesta:
    Plone es un sistema de gestor de contenidos empresarial (ECM/CMS)
    basado en Zope y CMF.

How-To

Un How-to es una descripción de una página con la explicación o pasos a seguir para conseguir una tarea u objetivo. Se pueden adjuntar archivos e imágenes . Normalmentes son breves, y no se extienden mas allá del objetivo.

How-Tos típicos:

• Cómo configurar Plone con el servidor web Apache
• Cómo cambiar la apariencia de las pestañas que aparecen en el portal

Tutorial

Un tutorial es un articulo de varias paginas, con muchos detalles. El tutorial trata mucho mas produndamnte los temas que un How-to , y puede cubrir aspector conceptuales de la tarea, ademas de los pasos practicos para conseguir una tarea.

Si tienes dudas en las diferencias entree un how-to y un tutorial, piensalo como la diferencia entre una receta donde solo te explican los ingredientes que necesitas y como cocinar la tarta (how-to), y un artículo explicandote la historia que hay detras de las tartas en general, podria explicarte o no,  cómo cocinar una (tutorial).

Tutoriales típicos:

• Como utilitzar flujos de trabajo en tus proyectos.
• ¿Porque separar el contenido y la lógica de presentación?

Manual de referencia

Un manual de referencia es una parte de documentación definitiva o esencial para algun producto. Tiende a tener muchas paginas con secciones estructurando el contenido. 
Este tipo de documentación es de lejos el mas poco habitual en esta sección.

Enlaces 

Un enlace en la sección de documentación es un enlace :) (ya sea interno u externo). Se diferencia de los enlaces estandard de plone en que estos pueden tener secciones y información soble la versión.

Enlaces típicos:

• The Zope Book en zope.org (inglés)
• Mannual de referencia CSS en W3C  (inglés)

Referencias de error

Una referencia de error se entiende como la explicación de un error en concreto con detalles de cómo corregirlo, si ello es posible.

Referencias de error típicas:

• Expected sequence, got integer
• FS Page Template has errors: Compilation failed

Definición del glosario

Una definición de glosario da una descripción lo mas concisa posible de un termino usado.

Definiciones de glosario típicas:

• CMF: Entorno de Gestion de Contenidos (del inglés Content Management Framework ).
• Flujo de trabajo: Una estructura de maquina de estados, usada para modelar procesos y lógicas de negocio (en inglés Workflow).