Algunos recursos y sugerencias para la documentación de proyectos de grado en Ingeniería en Computación de la Facultad de Ingeniería de la Universidad de la República, Uruguay.

Recursos

• BibTex4Word. Una macro de word que permite integrar BibTex. Muy útil para el manejo de bibliografías. Ejemplos de estilos de bibliografías en LaTeX y la guía de la IEEE, también para referencias.

• La comparación de software de manejo de referencias, de la Wikipedia.

• Un diccionario científico del español.

• La Información para autores de la IEEE y el Digital Tool Box que incluye plantillas LaTeX.

• Beamer, un paquete de LaTeX para realizar presentaciones.

• La guía que contiene los puntos que en general deben estar presentes en un informe de proyecto de grado, propuesta por la comisión de proyecto de grado.

• IEEE Editorial Style Manual

• Pautas sobre los elementos considerados importantes para la redacción de un documento que describa el desarrollo de una actividad de investigación. Por Sergio Nesmachnow.

• Diccionario de la RAE

Sugerencias:

• Sólo citar y referenciar fuentes reconocidas y respetables (nunca a la Wikipedia. Tener en cuenta que la Wikipedia suele incluir referencias que sí pueden ser utilizadas.)

• Escribir formalmente, evitando el lenguaje coloquial y los relatos anecdóticos del proyecto. Recordar que, en general, se están documentando los resultados y no el proceso mediante el cual se llegó a ellos.

• La documentación es un trabajo formal. Esto implica que cualquier cosa que afirmen deberá o ser de sentido común, o estar demostrada por ustedes, o contar con una referencia que la avale.

• Utilizar español siempre que sea posible. Cuando no existe un equivalente en español, poner la palabra en el idioma foráneo en itálica.

• Evitar la castellanización de palabras en inglés (randómico por aleatorio, customizar por personalizar, zoomear o hacer zoom por ampliar, mandatorio por obligatorio, etc.).

  De igual forma, tener particular cuidado con los falsos amigos, es decir, palabras en un idioma que tienen, en otro idioma, otra de sonido similar y significado distinto. Ejemplos de errores inducidos por falsos amigos pueden encontrarse aquí.

• Los capítulos deberían empezar en páginas impares.

• Utilizar algún editor de texto que incluya un buen corrector ortográfico. Agregar sistemáticamente las palabras que no tenga.

• Tener cuidado con las tildes diacríticas (sé, se; sí, si; más, mas; él, el; tú, tu; etc.).

• Recordar que la palabra "o" sólo lleva tilde cuando se encuentra entre números.

• La conjugación verbal debe ser coherente (p.ej.: evitar poner "se hizo", y luego "hicimos").

• Tener claro que el proyecto, incluyendo su documentación, es un trabajo de los estudiantes. Entre otras cosas, esto implica que cuando envían la documentación a los tutores para su corrección, envían una versión que consideran final, lista para presentar al tribunal y no un boceto al cual los docentes deberán corregirle las faltas.

• Guillermo Moncecchi sugiere (queda un poco descolgado ya que se refiere a un proyecto de él, sin embargo es interesante):

  Respecto al informe: en el capítulo 3 pueden hacer una descripción del sistema sin hacer ninguna mención a ningún tipo de solución tecnológica concreta. O sea, No puede decir Java, XML, MySQL, ni nada de eso. Es el diseño del sistema, no su implementación.

  En el capítulo 4 (si en el proyecto la implementación es relevante), se habla de la arquitectura implementada, la solución tecnológica, etc. Aun ahí no va código fuente. Si quieren pueden poner un pseudocódigo, pero en un cuadrito.

• Los números se escriben con letras y no con dígitos ("tres", en lugar de 3), excepto en los casos en los que el número sea parte del nombre ("figura 1"), o cuando sea una palabra compuesta (en lugar de "treinta y uno", se deberá escribir 31).

• No utilizar abreviaturas innecesarias. Si se utilizan siglas, en la primera mención se pondrá su forma desarrollada seguida de la sigla entre paréntesis, sin puntos de separación; por ejemplo: Intendencia Municipal de Montevideo (IMM).

• Tener en cuenta que el uso de expresiones como "la misma", "el mismo", "de la misma" puede evitarse, en algunos casos sencillamente eliminando la expresión y en otros modificando ligeramente la frase. Por ejemplo: "Se determina el tipo de documento basándose en la estructura del mismo", puede sustituirse por "Se determina el tipo de documento basándose en su estructura". O "Como no se conoce la estructura del documento, es necesario realizar un análisis sintáctico del mismo", puede sustituirse por "Como no se conoce la estructura del documento, es necesario realizar un análisis sintáctico".

  Esto no quiere decir que su uso sea erróneo, mas sí su abuso.

• Salvo contadas excepciones, los prefijos no llevan guion ("-"). Así, se debe escribir examante, proaborto, anticlerical, etc. Sin embargo, sí se unen con guion a la palabra base cuando esta comienza por mayúscula (pos-Mujica), o antes de un número (sub-20). Finalmente, se deja un espacio cuando el prefijo afecta a una base pluriverbal (varias palabras), como en pre mundial del treinta o vice primer ministro.

• No omitir ni olvidar las tildes en las letras mayúsculas.

• Nunca utilizar subrayado.

• Por lo general, que estén pegados títulos y subtítulos no es bueno. Al tratarse de un informe y no de un manual, son necesarios ilación y estilo tales que permitan transmitir lo hecho sin aburrir al lector.

• Si utilizan Word (con LaTeX es natural hacerlo así), utilicen sus herramientas de estilo. No dejen espacios entre los párrafos o luego de los títulos agregando retornos de carro, sino definiendo estilos. Recuerden que hay una jerarquía de títulos. Utilicen los captions en las tablas, fotografías y figuras y siempre refiéranse a ellas mediante referencias cruzadas.

• Que la presentación final no dure más de 45 minutos (incluyendo la eventual demo). Si la mesa quiere más tiempo de demo, lo solicitará. Si el público quiere, habrá tiempo mientras la mesa delibera.

• Los slides (PPT, PDF, etc.) no deben ser leídos por el presentador. La única excepción es al realizar una cita textual (lo cual no conviene hacer más de una o -a lo sumo- dos veces). Su función es ayudar al presentador a hilar la charla y destacar los conceptos más importantes, facilitando su comprensión al público.

• La estructura de la presentación no tiene por qué (y en general no debe) corresponderse con la estructura del documento

• Finalmente, revisar, leer y releer el documento (y la presentación). Es imposible escribir todo perfecto de entrada.