Estándar de edición y publicación de contenidos para el Sitio Web

Transcripción

1 Estándar de edición y publicación de contenidos para el Sitio Web Para toda persona con presencia en el Sitio Web del, Jalisco. Versión 0.2 Julio de 2011 Departamento de TI

2 Versiones del Documento Departamento de Tecnologías de la Información Ver. Fecha Autor Revisor 0.2 julio de 2011 Adrián Castillo Sánchez Fernando G. Castolo Audiencia Documento de tipo confidencial y será utilizado por el área de e-gobierno del departamento de Tecnologías de la Información; también por toda persona que desee publicar información en el Sitio Web del, Jalisco. Sobre los documentos Propósito El contenido del Sitio Web es generado por las diferentes áreas que comprende el Gobierno Municipal, y las formas de edición y presentación de información es variado en cada una de ellas, ocasionando que la información no se presente de forma uniforme o estandarizada para el ciudadano, en Sitio Web es mejor presentar la información como una entidad única que trabajan en conjunto y no como si cada parte trabajara de forma individual. El estándar de edición está pensado para ser utilizado desde la solicitud de la información, la edición y su publicación, realizando las revisiones necesarias para cumplir adecuadamente con la uniformidad de los contenidos. El propósito de este documento es el generar un estándar para la edición y publicación de contenidos para el Sitio Web, que permita facilitar la edición de los revisores y comprensión de los visitantes al sitio de una forma más ágil, clara y objetiva. Uso del documento El presente documento será utilizado dentro del Gobierno Municipal en todas las direcciones, departamentos y/o organismos públicos descentralizados que deseen publicar contenido de sus acciones dentro del Sitio Web del. También será utilizado por toda persona ajena al Gobierno Municipal que por aprobación sea permitida la publicación de su información. Archivo: Estándar de edición y publicación de contenidos para el Sitio Web v02.docx Página 2

3 Tabla de contenido Versiones del Documento... 2 Audiencia... 2 Sobre los documentos... 2 Propósito... 2 Uso del documento... 2 Introducción... 4 Convenciones del documento... 4 Color y énfasis... 4 Palabras clave... 4 Símbolos... 4 Espacios de edición... 5 Editor del sitio... 5 Formato HTML... 5 Tipografía del contenido... 5 Recomendaciones generales... 5 Formato... 6 Otros... 7 Archivo: Estándar de edición y publicación de contenidos para el Sitio Web v02.docx Página 3

4 Introducción Este estándar de edición comprende todos los aspectos de la edición y publicación de contenidos para el Sitio Web del Gobierno Municipal, los editores y supervisores deben de implementar este estándar que de forma prudente debe tender siempre a lo práctico. El contenido debe de reflejar un estilo armonioso como si una única persona lo hubiera escrito de una sola vez. Cuando se revise el contenido publicado y por publicar, el estándar de edición y publicación deberá establecer cómo manejar el contenido existente. La legibilidad del contenido repercute directamente en lo bien que un redactor comprende la información que pretende publicar, la edición y revisión es la facilidad con la que podrá añadirse nueva información, modificar la ya existente y depurar ortografía, redacción y gramatización. Aunque la legibilidad y la revisión son resultado de muchos factores, una parte importante es la forma de la redacción. El estándar es el mejor método para que el equipo de publicación de contenidos del Sitio Web mantenga un contenido de calidad, haciendo revisiones continuas al contenido. El estándar de edición y publicación de contenidos, no es una guía para enseñar a redactar sino una forma de vaciar el contenido de manera uniforme. Convenciones del documento Este documento requiere de estándares para asegurar la claridad cuando se indiquen las reglas y líneas guías. Ciertas convenciones son usadas a través de este documento para añadir énfasis. Convenciones usadas a través del documento: Color y énfasis Negrita Palabras clave Siempre Nunca Evitar Tratar Ejemplo Razón Texto con énfasis adicional para resaltarlo. Enfatiza que la regla se debe de cumplir. Enfatiza que la acción nunca se debe de ejecutar. Enfatiza que la acción debe de ser prevenida, pero para algunas excepciones pueden existir. Enfatiza que la regla debe de cumplirse siempre y cuando sea posible y adecuado. Precede el texto, usado para ilustrar la regla o recomendación. Explica el propósito detrás de la regla o recomendación. Símbolos [ control ] Indica la existencia de un bóton o control en la interfaz de usuario, con el que se puede interactuar (nombre del mismo contenido entre corchetes). Archivo: Estándar de edición y publicación de contenidos para el Sitio Web v02.docx Página 4

5 Espacios de edición Los contenidos se podrán redactar de las siguientes formas: Editor del sitio, y Formato HTML Editor del sitio Editor directo existente en el Sitio Web el cual permite realizar el formato de las páginas de forma básica. Utilizando la barra de herramientas del mismo. Formato HTML Utilizar directamente la codificación de documentos en formato HTML sin utilizar CSS extra o apoyarse en los estilos existentes para el Sitio Web, esta codificación se puede hacer desde cualquier editor de texto. Tipografía del contenido Tipo Estilo editor Formato HTML Encabezado nivel 1 Heading 1 <h1>título</h1> Encabezado nivel 2 Heading 2 <h2>subtítulo</h2> Encabezado nivel 3 Heading 3 <h3>subtítulo</h3> Párrafos Párrafo <p>contenido</p> Texto en negritas Botón [ B ] <strong>contenido</strong> Texto en cursiva Botón [ I ] <em>contenido</em> Texto subrayado Botón [ U ] <u>contenido</u> Viñetas Botón [ ] <ul><li>contenido 1</li></ul> Recomendaciones generales Procurar una redacción simple y sencilla tomando en cuenta que la información será consultada por personas con diferentes niveles educativos y debe ser comprensible para todos. La información deberá de ser objetiva, atractiva, verídica y de interés público. La información deberá ser congruente respecto a las actividades que se llevan a cabo. Siempre utilizar texto en minúsculas, solamente con letra capital donde sea correcta su marcación y en siglas de abreviaciones. Tratar en los encabezados utilizar minúsculas y solamente la primer letra en mayúscula. Todo el texto debe de ser en español y en caso de no ser posible, presentar la traducción o explicación del mismo. Las imágenes incrustadas siempre deberán de llevar un texto que la describa. Evitar en los nombres de las imágenes y archivos adjuntos que tengan espacios, caracteres especiales y/o acentos. Archivo: Estándar de edición y publicación de contenidos para el Sitio Web v02.docx Página 5

6 Tratar que los nombres de las imágenes y archivos adjuntos sean descriptivos a lo que contienen para que a su descarga o uso sea más fácil identificarlos. Los documentos adjuntos, también serán objeto de revisión ortográfica y podrán ser devueltos en caso de ser necesario. Siempre al hacer mención del municipio utilizar su nombre completo Zapotlán El Grande y no solamente Zapotlán. Siempre al hacer mención de la ciudad cabecera del municipio, utilizar su nombre completo Ciudad Guzmán y no abreviaciones Ej. Cd. Guzmán o Guzmán. Siempre para referirse al vaso lacustre del valle, se tiene que hacer en términos de Laguna de Zapotlán y evitar Lago u otro concepto. Nunca publicar información confidencial o reservada (ver Ley de Transparencia). Evitar abreviaturas a menos que el nombre completo sea excesivo y se vaya a utilizar mucho en el texto o si la abreviatura del mismo ya es conocida. En el uso de abreviaturas use coherentemente las mismas. Una abreviatura solo debe de tener un significado y del mismo modo para cada palabra solo le debe de corresponder una abreviatura. Ej. Si utiliza min. Para abreviar mínimo, hágalo siempre así y no use también min. Para abreviar minuto, y esta debe de ser totalmente conocida por el equipo de edición para que en toda página se utilice en el mismo sentido tal abreviación. Evitar abreviaturas que su longitud sea mayor a 5 caracteres salvo sean siglas conocidas. Evitar publicar información obsoleta o caducada y de igual forma revisar periódicamente su información para evitar tener información antigua. Formato Nunca vaciar un texto excesivamente largo dentro de una sola página, mejor dividirla por temas y crear varias páginas que dependan del tema principal. No utilizar los espacios para crear tabulaciones dentro del texto, la razón es que en HTML la alineación con espacios queda a cargo del navegador en el que el visitante lo visualice por lo que lo mostrado en el editor de texto puede ser diferente al resultado final. Utilice los tamaños estándar que permite el editor de texto en su barra de herramientas. Al publicar un archivo adjunto para descarga, indicar su tamaño en Megabytes (MB) o Kilobytes (KB) para que el visitante decida o no descargar el archivo. Para mantener una homogeneidad en el sitio, el formato para números telefónicos será alguno de los siguientes: o Simple: (sólo dígitos locales). o Larga distancia: (000) (marcado entre paréntesis los números de la clave lada). o Larga distancia internacional (52) (000) (número del país, seguido de la clave lada y a continuación el número telefónico). En donde sea necesario los domicilios, llevarán el siguiente orden: Archivo: Estándar de edición y publicación de contenidos para el Sitio Web v02.docx Página 6

7 o Nombre completo de la calle, número (sin almohadilla #) y colonia ciudad, estado y código postal Ej. Av. Cristóbal Colón 62, Centro, Ciudad Guzmán, Jalisco. C.P En los domicilios poner el nombre completo de la calle con su prefijo, evitar: Colon 62, mejor: Av. Cristóbal Colón 62 La presentación del organigrama del área en caso necesitarlo, será de la siguiente forma: o Nombre del Jefe/Director Nombre del personal Nombre del personal Nombre del personal El organigrama de preferencia deberá incluirse en la parte final de la página principal del área, en caso de ser muy extenso puede ser una página independiente. Otros Cualquier otro formato, ajuste o diseño, será considerado primeramente por los supervisores para ser implementado de forma homogénea en el sitio y posteriormente añadido a este documento. Archivo: Estándar de edición y publicación de contenidos para el Sitio Web v02.docx Página 7