Estándares para la Generación de contenido en la Wiki ADA

Este documento se genera con el fin de establecer el formato de generación de contenido de la wiki de la empresa. A continuación se describen los comandos de la plantilla definida que se aplica a los contenidos. (Se recomienda la lectura previa del contenido Sintaxis de Formato ya que se asume que el usuario conoce el lenguaje de generación de contenido de la wiki doku).

Se propone la siguiente siguiente plantilla para la generación de contenido:

Todo el contenido generado en la wiki debe estar alineado a la izquierda, de esta forma se asegura la correcta visualización en cualquier dispositivo.

El uso de imágenes no es requerido sin embargo en ocasiones puede ser necesario para indicar o precisar una información. Favor tener presente las siguientes recomendaciones cuando las utilice:

Solo se deben cargar imágenes en formato .png¹⁾.

Evite el uso de imágenes superiores a 5 MB²⁾.

Si requiere el uso de más de una imagen en un mismo contenido solo utilice una imagen por fila.

• Imagen 1
• Imagen 2

• Evite el uso de caracteres especiales, solo se permite el carácter _ para separar nombres.
• Asigne nombres relacionados con el contenido que sube, se recomienda la siguiente definición de Ejemplo. Asumiendo que el contenido es Lenguajes de programación, las imágenes en este contenido podrían ser lenguaje001.png, lenguaje002.png …

Cuando suba imágenes a los contenidos tener presente que la imagen quede local al contenido (Ver sección Sintaxis de Formato). Ejemplo: Asuma que se está creando el siguiente contenido: ada:sicoferp y decide incluir imágenes en este contenido. Entonces debe subir las imágenes en ese mismo directorio

También llamados secciones, los títulos permiten distribuir el contenido. La wiki soporta 5 niveles de profundidad los cuales pueden ser utilizados de acuerdo a las necesidades del contenido sin embargo deben utilizarse en forma descendente. El buen uso de las secciones permitirá la autogeneración de tablas de contenido y mejorará los procesos de búsqueda. A continuación se describe el uso de los títulos.

• Titulo 1: Se utilizará para definir el título de la página.
• Titulo 2: Se utilizará para definir secciones principales del contenido.
• Titulo 3: Se utilizará para definir secciones secundarias de las secciones principales.
• Titulo 4 y Titulo 5: Se utilizarán a criterio del usuario, teniendo presente que deben estar contenidos en un titulo de mayor nivel.

Pueden utilizarse los tipos disponibles en la Wiki y pueden combinarse de acuerdo a las necesidades del contenido. Sin embargo deber tener presente la forma en la que deben emplearse.

• Listas Ordenadas:Se utilizarán para describir procesos o pasos secuenciales en los contenidos.
• Listas Desordenadas:Se utilizarán para resaltar ítems informativos de contenido.

Son el mecanismo de construcción y relación de la información de la Wiki, los enlaces se deben generar respetando la jerarquía de agrupación del contenido. A continuación se describe la forma de implementarlos con el siguiente enlace de ejemplo: [[ada:howto:wikidoc:standarwiki|Estándares para la Generación de contenido en la Wiki ADA]]

• Siempre los enlaces deben empezar con el grupo ada.
• No debe utilizar caracteres especiales ni espacios en la estructura del enlace (Solo se permite el carácter _ ).
• Los niveles dentro del enlace “:” no deben ser largos.
• Utilice niveles descriptivos al contenido.
• Utilice nombres de enlace referentes al contenido.
• No utilice caracteres especiales en el nombre del enlace.
• Si se utilizan enlaces de imágenes estos deben ser intuitivos al contenido que referencia.

Solo se permite la tipografía estándar de la wiki.

Los demás comandos no descritos en la plantilla se asumirán al estándar mostrado en el documento Sintaxis de Formato

←Volver atrás