Lab Reports

Although the lab activities can be carried out in pairs, the lab reports must be developed individually.
Lab reports must be written in English using the AsciiDoc lightweight markup language. To install AsciiDoc on Ubuntu, type at the 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
```
At the terminal, use the following command in order to produce the final version of the report in HTML5 format (replace file.txt with the actual document name):
```
asciidoc -b html5 -a data-uri -a pygments -a icons -a toc2 \
-a theme=flask -a iconsdir=/etc/asciidoc/images/icons file.txt
```

These are the sections that all lab reports must contain:

Section	Description
Header	Include the lab title and your student ID, full name, and e-mail.
Introduction	State the purpose and goals of the lab report. You should explain why someone should read your report and give a road-map explaining its structure.
Problem statement and proposed solution	Explain the problem and how you solved it. You should present it in a self-contained manner. Assume the report audience includes people who have taken a similar course but somewhere else. So they haven't read the text book, nor have they read the lab description.
Testing	It's your responsibility to test your code thoroughly as you write each procedure and to convince the reader that you know all your code works. If your code has a bug, report the bug and explain your testing and what you know about where the bug is in your program. If you fail to report a bug, the grader will assume you either (a) tested poorly or (b) were dishonest in your report. Either way, your grade should be more severely reduced than if you just report your bug.
Conclusion	Summarize what the reader should have learned.
Acknowledgments	(Optional) If somebody helped you during the lab or when writing your report, make sure to include her or his name in this section. Also, include your lab partner's name, in case you had one.
References	Include in this section any works consulted (books, web pages, etc.).

Consider the following as well:
- Use complete sentences, with proper grammar and spelling.
- Include in the report all the source code that you wrote to solve the problem.
- Do not include in the report any instructions or code taken from the lab description itself, except maybe for a few small code snippets that might offer a better overall context to your own code.
- Indent your Ruby source code with two spaces per logical level. Never use tab characters. Also check the Ruby Style Guidelines.
Document examples:
- A report written using AsciiDoc: lab0_report_A01160611.txt (UTF-8 encoding)
- The generated HTML: lab0_report_A01160611.html

Software Design and Architecture