- All program texts and necessary auxiliary files in a main directory
- No umlauts (characters with ANSI code > 127) in the file name
- No file name longer than 31 characters (MacOS restriction)
- In the main directory, a README.TXT file that provides information about:
- all files and their function
- Platform (operating system, programming environment with version information) on which the program is executable
- Components (e.g., Gertwol, Tagger) used in the project not part of the submission listed with version specifications.
- Instructions on how to call the main function(s) that make up the program(s).
Documentation is to be submitted in paper form (printed and spiral-bound) as well as electronically.
Files should either be in HTML, RTF or PDF format.
The documentations should contain the following information:
- Project objectives and steps of procedure with information about the achievement
- List of positive and negative results (e.g. This works well because, ... / That did not work, because ...)
- Documentation of the concepts, algorithms and resources used (This is best done while working on the project! Do not leave this to the end!)
- Flow charts can often be used to clearly summarize a system
- Sources for algorithms, classifications and lists (e.g. Where did the algorithm come from? Where does this classification come from? What was a certain list taken from?)
- Documentation of the various data formats (input and output formats for files)
- Annotated bibliography/link list (or summaries if this was part of the assignment)
- Notes on extensions/expansion options
- Commentated program code (if too big, only in the electronic version)
The following points should be clearly described in the oral presentation (15 mins):
- Problems encountered
- Approach to finding solutions
- Results of your work
The target audience for presentations is computational linguistics students who have passed the access requirements but do not possess an in-depth knowledge of the field. Therefore, technical details should not be presented as part of the oral presentation, but rather in the technical documentation.