Normas de presentacion de reportes tecnicos

Tabla de contenido

1 Introducción .................................................................................................................... 1

2 Manejo de estilos de presentación ................................................................................... 2

3 Otros aspectos de manejo de estilos ................................................................................ 3

3.1 Manejo de referencias .............................................................................................. 3

3.2 Estilo de código fuente ............................................................................................. 3

3.3 Numeración de capítulos .......................................................................................... 3

3.4 Manejo de referencias .............................................................................................. 3

3.5 Enumeraciones y listas ............................................................................................. 3

3.6 Conclusiones ............................................................................................................ 3

4 Bibliografía ...................................................................................................................... 3

1 Introducción

Este es un documento que muestra un ejemplo de formato de un reporte técnico en informática. Es preparado para que sea seguido en informes de talleres, proyectos o laboratorios de cursos. No pretende ser un documento completo, en cuanto a que no es exhaustivo en todos los detalles de edición técnica. En particular, no se ocupa de la edición de fórmulas matemáticas, ecuaciones, manejo de abreviaturas o acrónimos. A diferencia de un artículo científico, no tiene en su tabla de contenido resumen ni abstract. El objetivo fundamental es dar una guía inicial de manejo de formato y estilos en este tipo de documentos.

Este es un párrafo que permite tener un ejemplo del estilo normal que se quiere utilizar en el cuerpo del documento. El tamaño de página a utilizar siempre es Carta y el editor a utilizar es Microsoft Word 2007 o superior. Todo párrafo debe conservar este estilo predeterminado. El estilo normal se define en estilo de letra Times New Roman tamaño 12. Dado que el nombre del estilo no está en español, se utiliza para esas palabras el estilo denominado “Idioma extranjero”. Lo recomendado es utilizar este tipo de palabras o expresiones únicamente cuando su uso es generalizado en el contexto y una traducción resulta inapropiada. Son ejemplos de este caso las palabras software y hardware. Por el contrario, lo correcto es utilizar las expresiones bases de datos relacionales o gestión de transacciones en español. Para ver fácilmente los estilos que se utilizan, se recomienda abrir el menú estilos en word y seleccionar la opción de ver únicamente los que están en uso. Para facilitar y agilizar el proceso de edición se recomienda colocar esos estilos en la barra de acceso rápido de estilos del editor.

El uso de siglas solo es recomendado cuando es pertinente dentro del contexto del documento y facilita su lectura. Toda sigla debe ser descrita de forma extensiva la primera vez que se utiliza. Por ejemplo, cuando se desarrollan temas sobre requerimientos CRUD (Create, Retrieve, Update, Delete), o sobre el lenguaje XML (Extensible Markup Language) (1).

Todo documento técnico se escribe utilizando un lenguaje formal, en tiempo presente e impersonal. En particular no es adecuado el uso de condicionales o tiempo futuro para mostrar el estado de un desarrollo, una propuesta o un análisis de experimentación. Debe evitarse el uso de primera persona y referencias hacia adelante en el discurso. Deben observarse rigurosamente las normas de la gramática y la ortografía del idioma en el cual se escribe el documento. Es particularmente interesante la guía de estilo que se encuentra en (2), en la cual se describen reglas básicas bastante prácticas de cómo organizar el contenido.

2 Manejo de estilos de presentación

La escritura del documento debe respetar los estilos establecidos sin modificarlos. Los títulos de cada nivel tienen un tamaño, indentación y espaciado que debe ser conservado. En cuanto a los márgenes del documento, deben ser siempre 2 cm por cada uno de los costados. El espacio entre líneas siempre es simple y no se dejan líneas en blanco entre los párrafos. Usted no debe cambiar ni el tamaño de la letra ni el interlineado para ajustar su documento a la extensión en número de páginas que sea establecida en los criterios de entrega. Si quiere resaltar alguna parte del texto debe reteñirla, en ningún caso subrayarla.

En caso de insertar imágenes utilice el estilo Imagen que se encuentra en este formato. Numere en forma consecutiva las imágenes y deles un título. El título de la figura siempre debe ir en formato TítuloFigura. Referéncielas en el documento de acuerdo con ese número. Nunca debe dejar espacios en blanco en

...