ADENDA A LA PLANTILLA DOCUMENTAL PARA ... de...Adenda a la plantilla documental para informes...

ADENDA A LA PLANTILLA DOCUMENTAL PARA INFORMES

TÉCNICOS A OFICIALIZAR EN EL SGC

Bogotá, junio de 2020

Adenda a la plantilla documental para informes técnicos a oficializar en el SGC

Servicio Geológico Colombiano 2

CONTENIDO INTRODUCCIÓN 3 1 DISEÑO E IMPLEMENTACIÓN DE LA PLANTILLA 3

1.1 Revisión y configuración de márgenes 3

1.2 Administrador de estilos 4

1.3 Combinación de informes técnicos 6 2 PORTADA 6 3 CONTRAPORTADA 8 4 CONTENIDO 11 5 CUERPO DEL DOCUMENTO 11

5.1 Tablas 11

5.2 Figuras 12

5.2.1 Creación de figuras tipo mapas para documento 12

5.3 Espacio duro o Espacio irrompible 14

5.4 Ecuaciones 15

5.5 Acortador de URL 15 6 AGRADECIMIENTO 16 7 GLOSARIO 16



INTRODUCCIÓN

El grupo de oficialización integrado por Ma. Eugenia Chamorro G y Luis Eduardo Salas, en virtud de las múltiples consultas y solicitud de apoyo por parte de los generadores de productos documentales, integra en esta adenda información relevante a partir de la herramienta Office 1996 y respuestas dadas por parte de la editora Carolina Hernández a situaciones no detalladas en la plantilla documental vigente. Gran parte de la información aquí contemplada ya ha sido socializada y proporcionada en acompañamientos preoficialización a generadores de productos. Se espera de esta manera, facilitar el manejo de algunos contenidos presentados en la plantilla documental vigente, complementando y soportando algunos de sus apartados, para facilidad de los generadores de elementos o productos documentales de información geocientífica, quienes siguen el procedimiento de oficialización establecido en el Servicio Geológico Colombiano. Algunos temas se presentan a manera de un tutorial colaborativo con base en el cual, se puede tener acceso a ilustraciones de lo explicado en el documento para mejor entendimiento en su aplicación, lo cual deberá verse reflejado en una mejor resolución y presentación de los componentes documentales. Para su desarrollo y facilidad en su seguimiento, se sigue el orden del contenido de la plantilla documental vigente (código en Isolucion: F-GGC-OPG-006).

1 DISEÑO E IMPLEMENTACIÓN DE LA PLANTILLA Los autores documentales pueden revisar, ajustar o diseñar los parámetros de visualización de la plantilla documental utilizando las herramientas ilustrativas que se presentan en este capítulo. 1.1 Revisión y configuración de márgenes Las márgenes del documento corresponden a la siguiente configuración: superior: 2 cm, inferior: 3 cm, izquierdo: 3 cm, derecho: 3 cm, encuadernación: 0,5 cm. Para su visualización y modificación se sigue el paso a paso presentado en la Figura 1:



Figura 1. Configuración de márgenes

En los recuadros resaltados, opciones a escoger Fuente: Word Office 2016

1.2 Administrador de estilos La herramienta de administrador de estilos permite estandarizar u homogenizar a un solo estilo el documento, cuando se tienen apartados dentro del documento que obedecen al trabajo integrado de varias personas, algunas de las cuales usan versiones de office diferentes o configuración diferente a la de la plantilla. La Figura 2, ilustra el paso a paso en el uso de la herramienta para estos casos o aquellos en los que se hace necesario eliminar estilos que no se requieran.



Figura 2. Administrador de estilos

En los recuadros resaltados, opciones a escoger. En el recuadro verde se debe poner el documento en el que se quiere cargar los estilos de la plantilla documental

Fuente: Word Office 2016



1.3 Combinación de informes técnicos Esta herramienta agiliza y facilita la unión de varios documentos en uno solo, sin perder los estilos requerido. La Figura 3, presenta el paso a paso para el uso correcto de esta herramienta.

Figura 3. Herramienta combinación de documentos

En los recuadros rojos, opciones a escoger. Recuadro verde se ingresa el documento base y recuadro naranja se ingresa documento a cambianar

Fuente: Word Office 2016

Al finalizar este paso a paso se crea un nuevo archivo combinado mostrando el control de cambios, permitiéndose así generar el documento estandarizado.

2 PORTADA El tipo de portada obedece al tipo de producto documental: Informe técnico, memoria explicativa de una plancha, visita de emergencia o catálogo de unidades litoestratigráficas. Cada una de las portadas documentales vigentes se encuentran cargadas tanto en la herramienta Isolución del SGC (F-GGC-OPG-006), como en la página web institucional. Para el caso de los proyectos bajo contrato o convenio, los logos de las entidades participantes se distribuyen en el espacio superior de la plantilla, según se muestra en la Figura 4.



Figura 4. Portada Informes Técnicos Convenios

Fuente: https://www2.sgc.gov.co/Publicaciones/Paginas/Productos-oficializados.aspx

La portada debe presentar las ciudades separadas por comas, en los casos en que se relacione más de una ciudad.



3 CONTRAPORTADA La contraportada además del logo del Servicio Geológico lleva el de la dirección técnica de origen del producto y relaciona en orden jerárquico: director de la entidad o entidades participantes, director técnico del área de origen (caso del SGC), coordinador, supervisor, autores y participantes. En la parte inferior lleva la citación de los autores, que debe seguir el orden de presentación de estos, en sentido contrario a las manecillas del reloj (cuando son numerosos), teniendo cuidado de nombrar máximo 21 autores (norma APA vigente - 7ª Edición). En la Figura 5 se ilustra lo antes indicado. Para los autores, se recomienda no relacionar: profesiones, especialidades, experticias, apoyos puntuales o información que se considere relevante de los autores; para este detalle, después de la contraportada se puede crear una sección titulada ´´Sobre los autores´´ (Figura 6).

Figura 5. Contraportada

Fuente: tomado y modificado de https://www2.sgc.gov.co/Publicaciones/Paginas/Productos-oficializados.aspx



Figura 6. Modelo apartado Sobre los autores

Fuente: autores



A continuación, se ilustra un ejemplo de contraportada para convenios y contratos (Figura 7).

Figura 7. Ejemplo contraportada para convenios y contratos

Fuente: tomado y modificado de https://www2.sgc.gov.co/Publicaciones/Paginas/Productos-oficializados.aspx



4 CONTENIDO La plantilla documental relaciona el paso a paso de la configuración del contenido cuando este no se genere adecuadamente. La separación de los capítulos debe hacerse en forma manual (con un enter).

5 CUERPO DEL DOCUMENTO En este capítulo se recomienda tener en cuenta la utilización de la herramienta gramatical para revisión de puntos, espacios y mayúsculas. La mayúscula sostenida se restringe al título del primer nivel. Se explican aspectos inherentes a la presentación de tablas, fotografías y figuras. Igualmente, se ilustran algunas herramientas que permiten ajustar situaciones o inconvenientes presentados a los generadores de los documentos. 5.1 Tablas Las siguientes características deben ser cumplidas en las tablas: - El título debe ser breve, claro, explicativo, fuente calibri 11, no debe sobrepasar el

espacio horizontal que cubre la tabla y no debe llevar punto final. En el texto del documento la tabla se cita (tabla 1) para el caso en que no se utilicen referencias cruzadas.

- No debe haber espacios entre El título y la tabla. - Los valores numéricos y datos deben estar en minúscula, fuente calibri entre 6 y 10

pts., buscando utilizar en lo posible, una fuente similar para las tablas de igual tamaño, en todo el documento.

- En lo posible no debe haber combinación de letras en negrillas con normales. - Las tablas deben presentarse editables, centradas, en lo posible con información en

minúscula, líneas internas de contorno en color negro y grosor 0,5 pts., sin color en el encabezado o las filas, a no ser que el color responda a alguna convención.

- Todas las tablas deben tener fuente de información, al final de la tabla en calibrí 10 pts.

- Repiten el encabezado en cada página de continuación. - Cuando la tabla deba presentarse en sentido horizontal, el título debe ir igual. El

ejemplo de la plantilla documental es claro al respecto.



5.2 Figuras Para el caso de las figuras debe revisarse (aplica para el documento principal y anexos): - Esté relacionada en orden consecutivo en el texto como (figura 1) en caso de que no

utilice referencias cruzadas y estar presentada después de su nombramiento, si cabe en la misma página.

- El título debe ser breve, claro y explicativo, no sobrepasar el espacio horizontal que cubre la figura, escrito en fuente calibri 11, sin punto final.

- La explicación asociada a la figura debe colocarse a parte del título, centrada y en Calibri 10 pts.

- Las figuras van centradas y con línea de contorno en color negro de grosor 0,5 pts. Para el caso de figuras múltiples, el borde o contorno debe ser tanto individual como grupal, cubriendo la totalidad de la figura.

- Las fotografías deben estar georreferenciadas (coordenadas geográficas y azimut) y tener una resolución entre 300 - 600 Dpi, dependiendo de la imagen.

- Las figuras que presenten diagramas o gráficos deben tener legibles (mínimo 6 pts.) títulos de los ejes y las unidades respectivas.

- Las figuras que presentan mapas, a no ser que sean esquemáticas, deben tener el Norte, legibles las coordenadas, convenciones, leyendas y escalas.

- Cuando la figura deba presentarse en sentido horizontal, el título debe ir igual.

5.2.1. Creación de figuras tipo mapas para documento La presentación de las figuras tipo mapas en los informes, se ha convertido en un dolor de cabeza para los autores de documentos ya que, al insertar la figura con tamaño superior a la dimensión del documento (tamaño carta), ésta se reduce perdiendo legibilidad y resolución, por tal motivo se establece el siguiente paso a paso para crear figuras tipo mapa usando la herramienta Arcgis –ArcMap (Figura 8 y Figura 9).



Figura 8. Creación figuras tipo mapa para documento

En los recuadros rojos, opciones a escoger (tamaños de la hoja entre A4, A5 y A6) Fuente: Arcmap -ESRI



Figura 9. Template ejemplo figura tipo mapa

Fuente: autores

5.3 Espacio duro o Espacio irrompible Los espacios duros o irrompibles permiten unir palabras, cifras o símbolos en una sola línea, de esta manera se mejora la presentación de textos que tienen grandes espacios entre palabras. Para hacer esta corrección visual se habilita la función mostrar todo (Ctrl +0), borra el espacio entre palabras y pulsar Ctrl +Shif + Espacio.



5.4 Ecuaciones Las ecuaciones en el documento, deben presentarse centradas, en fuente calibri 12 (los subíndices o superíndices se ajustan automáticamente al tamaño) y la numeración en corchetes.

Ejemplo: X = M+A+L [1]

5.5 Acortador de URL Actualmente las URL largas no se utilizan en documentos técnicos, por ende, se han creado un sin número de herramientas que permiten disminuir caracteres, reduciendo considerablemente la extensión de la URL, realizar la personalización de la URL y llevar a cabo estadísticos de visitas o clics. Se recomienda utilizar el acortador de URL gratuito cutty (https://cutt.ly/es). Para su visualización y carga seguir el paso a paso en la Figura 10:

Figura 10. Herramienta acortador de URL

En los recuadros resaltados con rojo opciones a escoger, en naranja opciones complementarias de la herramienta

Fuente: https://cutt.ly/es



6 AGRADECIMIENTO Se puede crear esta sección para agradecer o mencionar a las personas que se involucraron en el desarrollo del proyecto, representantes de entidades y otras que hayan participado en la apropiación del conocimiento técnico. Los agradecimientos deben presentarse antes de las referencias bibliográficas.

7 GLOSARIO El glosario permite clarificar términos técnicos o nuevos en el documento. Se debe ubicar antes de las referencias bibliográficas.



ÍNDICE DE FIGURAS Figura 1. Configuración de márgenes 4

Figura 2. Administrador de estilos 5

Figura 3. Herramienta combinación de documentos 6

Figura 4. Portada Informes Técnicos Convenios 7

Figura 5. Contraportada 8

Figura 6. Modelo apartado Sobre los autores 9

Figura 7. Ejemplo contraportada para convenios y contratos 10

Figura 8. Creación figuras tipo mapa para documento 13

Figura 9. Template ejemplo figura tipo mapa 14

Figura 10. Herramienta acortador de URL 15

ADENDA A LA PLANTILLA DOCUMENTAL PARA ... de...Adenda a la plantilla documental para informes...

Documents

Transcript of ADENDA A LA PLANTILLA DOCUMENTAL PARA ... de...Adenda a la plantilla documental para informes...