Los reportes de las prácticas deben ser elaboradas en español usando el formato de documentos AsciiDoctor. Para instalar AsciiDoctor en Ubuntu, teclear desde la terminal:
sudo apt-get update
sudo apt-get install ruby-dev
sudo gem install asciidoctor pygments.rb
sudo gem install --pre asciidoctor-pdf
Se debe utilizar el siguiente comando en la terminal para generar el reporte en formato PDF, reemplazando archivo.adoc
por el nombre correcto:
asciidoctor-pdf archivo.adoc
Ligas útiles de AsciiDoctor:
Estas son las secciones que debe contener todo reporte:
Sección | Descripción |
---|---|
Portada | Incluye el título de la práctica, así como las matrículas, nombres y correos electrónicos de los autores del reporte. |
Introducción | Establece el propósito y la estructura del contenido del reporte. Debe tener una extension de al menos 100 palabras. |
Desarrollo |
Explica a detalle el problema y la manera en que se procedió a resolverlo. Esto se debe hacer de manera auto-contenida. Esto significa que se debe suponer que el público que leerá el reporte ha llevado este mismo curso, pero en alguna otra universidad y, por tanto, no ha leído los mismos libros ni tampoco la descripción de la práctica del laboratorio.
También se debe incluir en esta sección todo el código fuente que se haya escrito para resolver el problema. |
Pruebas | Incluye las imágenes de las pantallas con la salida producida por el programa. Los autores son responsables de probar todas las funciones, clases o métodos de manera completa y convencer al lector de que todo el código funciona correctamente. Si el código contiene algún bug se debe documentarlo en el reporte, explicando todo lo que se sabe sobre él. Si no se reporta un bug se puede suponer que: (a) las pruebas fueron inadecuadas y/o insuficientes o (b) se fue deshonesto en el reporte. De cualquier forma, la calificación será reducida de manera más severa que si simplemente se hubiera reportado el bug. |
Conclusión | Resume lo que los autores aprendieron durante el proceso de elaboración de la práctica. Debe tener una extension de al menos 100 palabras. |
Agradecimientos | (Opcional) Incluye el nombre de cualquier persona que haya contribuido o ayudado a desarrollar la práctica de laboratorio. |
Referencias | Incluye los datos de cualquier documento consultado (electrónico o en papel). |
Es importante que también se consideren los siguientes puntos al momento de elaborar los reportes:
Respecto al código fuente de JavaScript desarrollado:
'use strict';
==
ni !=
. En su lugar usar siempre ===
y !==
.
Ejemplos de documentos:
Este documento está parcialmente basado en: Suggestions for clear lab reports in computer science courses.