MANUAL PARA LA ELABORACIN DE DOCUMENTOS IC-EI-003

NOMBRE DEL DOCUMENTO: Manual para la elaboracin de documentos CDIGO DEL DOCUMENTO: IC-EI-003

Documento:

Manual para la elaboracin de documentos ALINEACIN VERTICAL FAA CGS 30/06/2011 01/07/2011

Proyecto:

-NO VA ESTA CELDA -NO VA ESTA CELDA Idioma Rev. Pginas ES A

17

Preparado por: Revisado por: Aprobado por:

Cliente: N Doc. IC-EI-003

NDICE Introduccin ............................................................................................................ 3 Finalidad ................................................................................................................. 3 Forma y Formato para la Elaboracin de Documentos ........................................ 4 1. Fuente y Tamao de Letra .............................................................................. 4 2. Mrgenes, Alineacin y Espaciados entre Lneas ....................................... 54 3. Negrita, Subrayado y Cursivas ..................................................................... 65 4. Cartula ........................................................................................................... 6 5. Numeracin de Captulos y Sub-Captulos .................................................. 76 6. Numeracin de Tablas y Grficos................................................................. 87 7. Numeracin de Pginas .............................................................................. 109 8. Pie de pgina ............................................................................................... 109 9. Redaccin .................................................................................................... 109 10. 11. 12. ndice ........................................................................................................ 109 Anexos ...................................................................................................... 119 Control de Versiones ............................................................................. 1110

Control de cambios usando Microsoft Word ...................................................1110 Anexo 01: Formato de cartula y de pginas .................................................1514

Comment [CGS1]: Hay puntos que no estn numerados, antes del 1, y despus del 12. por que ?

Manual para la elaboracin de documentos IC-IE-003 Rev. A 2 de 17

INDUSTRIAL CONTROLS SAC

JUNIO 2011

Introduccin El mantener un eficiente flujo en las comunicaciones, tanto internas como externas, es fundamental para el xito de cualquier tarea que un grupo de trabajo desee emprender y cumplir con eficiencia, para ello, el uso adecuado de medios de comunicacin formal se dilucida como la piedra fundamental para una adecuada comunicacin a la vez de asegurar la trazabilidad de cualquier procedimiento que se realice; as, este manual trata de asegurar la correcta creacin de documentos de cualquier ndole, a fin de que el trabajo de elaboracin y revisin de estos pueda llevarse a cabo de manera correcta, fcil y ordenada.

Comment [CGS2]: Por que no est numera este punto

Comment [CGS3]: Parrafo muy largo.

Finalidad El presente manual tiene como finalidad explicar de una manera clara y concisa, las caractersticas y la forma a utilizarse en la elaboracin de diversos documentos de texto tales como los filosofas de control, informes, memorias, manuales, reportes, etc; que utilizan las reas de Ingeniera y Proyectos para el desarrollo de sus funciones y para la comunicacin de esta con sus clientes y stakeholders. Y que cubre los siguientes objetivos: Definir la estructura bsica que debe tener un documento realizado por las reas de Ingeniera y Proyectos. Definir el formato que deben tener los documentos realizados por las reas Establecer las normas de redaccin bsicas que se deben tener en cuenta al momento de redactar un documento por los miembros de las reas. Definir una plantilla Word con todas las caractersticas establecidas como estandares para la elaboracin de documentos. Dar una gua bsica para el uso del control de cambios de Word.

Comment [CGS4]: Mas usual en ingeniera : objetivo

Comment [CGS5]: Porque no est numerad este punto

Comment [CGS6]: aEsta lnea parece (por texto) que forma parte del anterior prrafo, sin embargo esta suelto

Manual para la elaboracin de documentos IC-IE-003 Rev.A 3 de 17

INDUSTRIAL CONTROLS SAC

JUNIO 2011

Forma y Formato para la Elaboracin de Documentos 1. Fuente y Tamao de Letra Para todo documento creado por las reas de Ingeniera y Proyectos, se deber usar letra Arial del tamao nmero 12. El color de la fuente ser siempre negra negro. El uso , la utilizacin de color dentro de los textos solo estar destinado al logo o isotipo de Industrial Controls, las cuales sern conforme al color establecido en el Manual de identidad corporativa (dar ruta en el Z)..
Comment [CGS7]: El color es negro, no negra

Figura 1 En ningn momento se utilizarn efectos para el texto ni los cuadros que compongan el documento. Mencionar en algn lugar algo sobre el mal uso de las maysculas y sobre la acentuacin de ellas.
Manual para la elaboracin de documentos IC-IE-003 Rev.A 4 de 17 INDUSTRIAL CONTROLS SAC
JUNIO 2011

2.

Mrgenes, Alineacin y Espaciados entre Lneas Los mrgenes de cualquier documento emitido por las reas de Ingeniera y Proyectos debern tener las siguientes medidas: 3.0 mm en el margen derecho, 2.5 mm de margen izquierdo, 2.5 mm en el tope superior de la pgina y 2.5 mm en el pie de la misma. Cada vez que se describan ajustes que ya estn establecidos en la plantilla de Word, mencionarlo, para que el usuario sepa que no debe preocuparse por ello. Mencionar la existencia de la plantilla, antes hablar de ella, y dar su ruta en el Z. La plantilla debe ser un documento de solo lectura.

Figura 2 La alineacin de todos los prrafos que comprendan un documento emitido por las reas de Ingeniera y Proyectos deber ser del tipo Justificado; as mismo, los espacios de interlineado debern ser del tipo sencillo.

Manual para la elaboracin de documentos IC-IE-003 Rev.A 5 de 17

INDUSTRIAL CONTROLS SAC

JUNIO 2011

Figura 3 3. Negrita, Subrayado y Cursivas La utilizacin de la negrita solo estar destinada a resaltar ttulos, ya sea el ttulo general o de una seccin del informe, para el resaltado de alguna frase o palabra dentro del texto de alguna seccin del informe se utilizar el estilo cursivo. No se permitir el subrayado dentro de los documentos realizados por las reas de Ingeniera y Proyectos.

Comment [CGS8]: Esto est implcito

Figura 4 4. Cartula Para la elaboracin de la Cartula del informe se deber tener en cuenta el ttulo, el cual deber reflejar, de manera clara y concisa, el tema del que se est tratando dentro del documento; as mismo deber contener el cdigo del proyecto
Manual para la elaboracin de documentos IC-IE-003 Rev.A 6 de 17 INDUSTRIAL CONTROLS SAC
JUNIO 2011

al que pertenece, as como el nombre del cliente y el nombre del proyecto. Para ello se utilizar letras de tipo Arial en negritas de tamao 20; el ttulo deber estar colocado en el centro de la cartula. En el Anexo 01 se adjunta el formato completo de cartula. 5. Formato de Fecha Al momento de especificar de modo abreviado fechas dentro del documento, estas se harn considerando el siguiente orden: primero se especificar el da, luego el mes y finalmente el ao. Adems quedar definido por el siguiente formato: dd/mm/aaaa. Tambin dentro de la redaccin, las fechas se podrn escribir usando el formato combinado de nmeros y letras siguiendo el mismo orden de da, mes y ao, determinado en el prrafo anterior. 6. Numeracin de Captulos y Sub-Captulos La numeracin de los captulos seguir una progresin numrica, utilizando la aplicacin de formatos preestablecidos denominados Estilos. Para ello se dispone del archivo de Word denominado: Formato Modelo para elaboracin de documentos.doc, el cual posee los estilos configurados y que establecen los niveles y subniveles de subttulos de acuerdo a la siguiente descripcin: 1. 1.1 Ttulo 1 Subttulo 1.1 corresponde al Estilo: Ttulo 1 corresponde al Estilo: Ttulo 2

Comment [CGS9]: . Revisar caratula con designado por ingeniera y considerar alguno tipos adicionaes que fueran necesarios.

Comment [CGS10]: Poner ejemplos

1.1.1 Subttulo 1.1.1 corresponde al Estilo: Ttulo 3 Cada vez que sea necesario agregar un captulo o sub-captulo, esta herramienta agregar un nmero precedido de un punto a cada subnivel que se agregue. Para ello solo ser necesario seleccionar el ttulo y aplicar el estilo correspondiente conforme a las relaciones previamente descritas, tal como se muestra en la figura 5. Aca debe ir la figura 5 A fin de que la informacin mantenga un orden tanto de concordancia como visual, la creacin de subdivisiones solo se realizar de ser estrictamente necesario, si se ha de numerar una serie de elementos que no necesiten mayor explicacin, no se deber crear un sub-captulo; para esos casos solo se har uso de vietas, cuya seleccin de tipo queda a criterio del usuario. Tal como se muestra en la figura 6.

Comment [CGS11]: Mejor estandarizarlas. Hay unos tipos demasiado inapropiados. Establecer incluso una jerarqua de vietas, pues a veces se anidan.

Manual para la elaboracin de documentos IC-IE-003 Rev.A 7 de 17

INDUSTRIAL CONTROLS SAC

JUNIO 2011

Figura 5

Figura 6 7. Numeracin de Tablas y Grficos Las tablas, al igual que los grficos las figuras, ser diferenciados por medio de nmeros, los cuales seguirn una progresin numrica, debiendo identificarlos, al pie de cada tabla o grfico, usando letras en cursiva y negritas de manera simultnea. Por ejemplo: Tabla 1, Tabla 2, Tabla 3 o Figura 1, Figura 2, Figura 3...
Manual para la elaboracin de documentos IC-IE-003 Rev.A 8 de 17 INDUSTRIAL CONTROLS SAC
JUNIO 2011

Comment [CGS12]: Si en todo el texto les llamas figuras, hay que llamarles figuras.

Para generar la numeracin de figuras y tablas, se deber usar la herramienta de Microsoft Word 2010 denominada: Insertar Ttulo. Para ello se deber posicionar el cursor sobre el objeto (imgenes o tablas) y haciendo clic derecho se podr acceder al men donde se encuentra dicha opcin, tal como se muestra en la figura 7.

Aca debe ir la figura 7 Esta Herramienta permitir escoger o personalizar el nombre de los rtulos que en este caso sern Figura y Tabla, que se seleccionarn segn sea el tipo de objeto a enumerar. Con esto se generar un nmero correlativo por cada ttulo de imagen o tabla que se inserte, haciendo ms ordenada la numeracin de este tipo de objetos.

Figura 7 Se debe tener presente que la opcin numeracin queda configurada en la plantilla de Word al tipo numrico, tal como se muestra en la opcin Numeracin de Ttulos de la figura 8.

Manual para la elaboracin de documentos IC-IE-003 Rev.A 9 de 17

INDUSTRIAL CONTROLS SAC

JUNIO 2011

Figura 8 8. Numeracin de Pginas Las pginas sern numeradas mediante numeracin arbiga siguiendo una progresin numrica desde la pgina uno hasta aquella en que finalice el documento. T, toda pgina ser contada, pero en la aquellas que corresponda a cartulas la numeracin no ser expresada pero si considerada en el correlativo. La numeracin de las pginas se har en la parte inferior del documento, utilizando para ello la herramienta de encabezamiento y pie de pgina de Word cuya distribucin y formato se encuentran definidos en el archivo Word . 9. Pie de pgina Cada pgina debe llevar el nombre del documento, el cdigo de documento seguido por la revisin del mismo. As tambin debe ser identificado con el nombre de la empresa y el mes en que fue editado. La configuracin y distribucin tambin se encuentra en el formato modelo para elaboracin de documentos. As tambin, en el anexo 01 se muestra el formato de pie de pgina que debe tener el documento. 10. Redaccin Se debern tomar, al momento de redactar un documento, las siguientes consideraciones; cuidar el uso correcto de las reglas ortogrficas para lo cual se deber usar con criterio el corrector ortogrfico del Word antes de considerar finalizado el documento; as mismo revisar la concordancia de entre gnero y entre nmero al momento de redactar el documento; as como revisar las normas ortogrficas y gramaticales bsicas, sobre todo en lo referente a la acentuacin de las palabras y el correcto uso de tildes y dems signos de puntuacin. 11. ndice Todo documento Cada informe realizado por las reas de Ingeniera y Proyectos deber tener, seguidamente a la cartula, un ndice que permita al lector tener una visin general del contenido del documento. E; en este ndice se deber consignar todos los captulos y de los que est conformado el documento, as como todos los sub-captulos que hubieren; estos debern contar con la
Manual para la elaboracin de documentos IC-IE-003 Rev.A 10 de 17 INDUSTRIAL CONTROLS SAC
JUNIO 2011

numeracin de los captulos y sub-captulos tal como se defini en el acpite correspondiente. En el disco Z, en la ruta : Z:\INGENIERIA\FORMATOS , se encuentra la plantilla de Word denominada Formato Modelo para elaboracin de documentos.doc, que ya posee los formatos y configuraciones establecidos para el documento. En esta plantilla, ser posible insertar el ndice usando la herramienta Tabla de contenido de Microsoft Word 2010. 12. Anexos De necesitar adjuntar informacin complementaria a la ya expuesta dentro del informe, esta deber ser adjuntada al documento como un anexo al mismo; as, todo anexo deber ser identificado siguiendo una progresin numrica, aumentando un nmero por cada anexo agregado; ejemplo: Anexo 01, Anexo 02, Anexo 03; por ltimo todo documento o informacin anexa deber ser descrita de manera concreta dentro del ndice del informe. El inicio de cada anexo debe ser en una nueva pagina. 13. Control de Versiones Cada vez que un informe sufra una revisin o un cambio sustancial dentro de su contenido, deber consignarse dicho documento como una versin del mismo; para ello se utilizar una letra, el cual iniciar en la letra A y aumentar en una progresin alfabtica a medida que se cree una nueva versin; dicha descripcin deber ser consignada a pie de pgina. Adems, cuando el documento sea aprobado, le corresponder el nmero de revisin 0. Posteriores versiones a la 0 se identificaran correlativamente, mediante nmeros. Control de cambios usando Microsoft Word Adicionalmente, dDebido a que el documento sufre revisiones por distintas personas, es importante conservar especficamente los cambios realizados as como la identidad del ejecutor del cambio. Microsoft Word posee una herramienta para gestionar las revisiones y permite a los usuarios poder visualizar los cambios realizados as como al usuario que lo realiz. La herramienta se denomina Control de cambios y se encuentra en la pestaa Revisar del entorno principal de Word. El primer usuario que genera la versin inicial del documento debe dejar activa la herramienta, haciendo clic en la opcin Control de cambios, como se muestra en la figura 9.
Comment [CGS13]: Por que no esta numerado este punto

Manual para la elaboracin de documentos IC-IE-003 Rev.A 11 de 17

INDUSTRIAL CONTROLS SAC

JUNIO 2011

Figura 9 As tambin cada usuario debe asegurarse de tener debidamente configurado su nombre, para que de esta forma pueda ser identificado reconocido por el resto de los usuarios como el autor de los cambios que halla propueto y de los comentarios que haya realizado. Esto se Como se muestran en las figuras 10 y 11.

Figura 10

Manual para la elaboracin de documentos IC-IE-003 Rev.A 12 de 17

INDUSTRIAL CONTROLS SAC

JUNIO 2011

Figura 11 De esta manera el documento podr pasar por los usuarios involucrados, conservando los cambios de cada uno, los cuales sern mostrados en distintos colores de letra. Estos cambios son registrados para cada usuario, como en el caso de la figura 12, donde se muestra en color rojo los cambios realizados por el usuario Romer. Las palabras en rojo representan las agregadas, mientras que las tachadas simbolizan a las eliminadas por el usuario Romer.

Figura 12 Existen variaso vistas,.s tipos de vista, en el caso de Lla figura 12 corresponde a la vista Original: Mostrar revisiones, en ella podemos ver las revisiones de todos los usuarios. Tambin existe el tipo: Final, que muestra al documento con los cambios realizados pero sin resaltarlos, tal como se muestra en la figura 13.

Comment [CGS14]: Como se accede a esa vistas ??

XXXX

Comment [CGS15]: Aca debe ir la figura 12 no antes.

Manual para la elaboracin de documentos IC-IE-003 Rev.A 13 de 17

INDUSTRIAL CONTROLS SAC

JUNIO 2011

Figura 13

Una vez concluidas todas las revisiones, el usuario responsable de la aprobacin del documento debe generar la versin final, para ello debe aceptar o rechazar cada una de las modificaciones realizadas. Obtenindose de esta manera, la versin final del documento. Para esto usarn las herramientas Aceptar y Rechazar, las cuales se encuentran dentro de la pestaa Revisar, tal como se muestra en la figura 14.

Figura 14

Manual para la elaboracin de documentos IC-IE-003 Rev.A 14 de 17

INDUSTRIAL CONTROLS SAC

JUNIO 2011

Anexos

Anexo 01: Formato de cartula y de pginas

Manual para la elaboracin de documentos IC-IE-003 Rev.A 15 de 17

INDUSTRIAL CONTROLS SAC

JUNIO 2011

PROYECTO

CDIGO DEL PROYECTO

LOGOTIPO DEL CLIENTE

(En caso aplique)

NOMBRE DEL DOCUMENTO: CDIGO DEL DOCUMENTO:

Documento: Preparado por: Revisado por: Aprobado por: DD/MM/AAAA DD/MM/AAAA DD/MM/AAAA

Proyecto: Cliente: N Doc. Idioma Rev. Pginas ES 0

NDICE

Nombre del documento Cdigo del documento Rev. 17 de 17

INDUSTRIAL CONTROLS SAC

MES AO