Los reportes de las prácticas deben ser elaborados en español usando AsciiDoc. Para instalar AsciiDoc en Ubuntu teclea desde la terminal:
sudo apt-get install asciidoc python-pygments
sudo wget http://34.212.143.74/downloads/pygmentize/tango.css \ -O /etc/asciidoc/stylesheets/pygments.css
Utiliza el siguiente comando en la terminal para producir la versión final del reporte en formato HTML5 (reemplazando archivo.txt
por el nombre real del documento):
asciidoc -b html5 -a lang=es -a data-uri -a pygments \ -a icons -a toc -a theme=flask \ -a iconsdir=/etc/asciidoc/images/icons archivo.txt
Sección | Descripción |
---|---|
Encabezado | Debe incluir el título de la práctica, así como la matrícula, nombre y correo electrónico del autor del reporte. |
Introducción | Establece el propósito y la estructura del contenido posterior. Al lector le debe quedar claro por qué debe leer el reporte. |
Planteamiento del problema y solución | Explica a detalle el problema y la manera en que se procedió a resolverlo. Esto se debe hacer de manera auto-contenida. Debes asumir que el público que leerá el reporte ha llevado este mismo curso, pero en alguna otra universidad. Esto quiere decir que no han leído los mismos libros, ni tampoco la descripción de la práctica del laboratorio. |
Pruebas | Es tu responsabilidad probar tus funciones, clases o métodos de manera completa y convencer al lector que estás seguro que todo tu código funciona correctamente. Si tu código contiene un bug, debes documentarlo en tu reporte, explicando todo lo que sabes sobre él. Si no reportas un bug se asume que: (a) tus pruebas fueron inadecuadas y/o insuficientes o (b) fuiste deshonesto en tu reporte. De cualquier forma, tu calificación será reducida de manera más severa que si simplemente hubieras reportado el bug. |
Conclusión | Resume lo que el lector debió haber aprendido. |
Agradecimientos | (Opcional) Incluye el nombre de cualquier persona que te haya ayudado a desarrollar la práctica de laboratorio. Si la práctica la elaboraste en pareja, incluye también en esta sección el nombre de tu compañero de laboratorio. |
Referencias | Cualquier documento consultado (electrónico o en papel) debe ser incluido en esta sección. |
Es importante también que consideres los siguientes puntos al momento de elaborar tus reportes:
Respecto al código fuente de JavaScript que tú elabores:
'use strict';
==
ni !=
. En su lugar usa siempre ===
y !==
.
Este documento está basado en: Suggestions for clear lab reports in computer science courses.