Documentation Requirements (Back to Beginning)

Your assignment must be submitted in the form of a single zip archive file (or tar file) via the Unit LMS. The zip file must be named in the following format:

A1_<your first name>_<your family name>.zip

For example, the student, John Smith, would name his zip file as A1_John_Smith.zip.

Your zip archive must contain the following files:

    One Microsoft Word document named "Assignment1.docx". This file replaces the traditional hard-copy submission. See the detailed requirements of this file later in this section. Where possible, I prefer Office Open XML format (ie, .docx). This format generally leads to smaller file size compared to other format due to compression. Other Word formats such as .doc or .rtf are also acceptable if you cannot use .docx format.

    For each programming question (ie, Question 2 to Question 4), you must include a separate folder appropriately named (ie, q2, q3 and q4) that contains
        the source code for the question
        the Linux executable for the program
        all test files used in the test, as well as test output of your program

You can create output file by cut-and-pasting from your terminal output into a text file. A better way is use standard output redirection, such as

              q3 > q3_output.txt


You must make sure that your program can be compiled and run on other machines. Do not use any non-standard feature or any feature that is only available in your machine. Do not hard code any directory path into your program otherwise your program may not run on someone else's machine.
The file "Assignment1.docx"

This Word file should contain the documents in the following order:

    ICT374 Major Assignment One Check List: all students (internal and external) must complete this check list and include it in your Word file.

    Extension Granted: if you have been granted extension, include the email from your Unit Coordinator after the declaration form.

    List of Files: list the name and purpose of each file included in the tar archives.

    Include documents for each question in the order of question numbers. For each question, you must include

        The question itself : you can cut-and-paste the question from this web page to your Word file.

        Your answer (theory question only) : please note the marks are not awarded purely based on the length of your answer. Most questions can be answered in half to one page.

        Self diagnosis and evaluation(programming question only) : a statement giving following details for each requiement of the question: what have been fully completed and working, and what have been fully completed but not fully working, and what are not been fully completed or not attempted. This statement is essential. You will lose at least 50% of the mark allocated to the question if this statement is missing, misleading, or too vague.

        Test evidence (programming questions only) : depending on the nature of the problem, you may need one or more test cases to demonstrate that your program has met all requirements.

        When testing your program, please turn on the gcc warning (gcc -Wall ...), and make sure you fixed all warnings before submitting your program.

        For each test case, you should 1) explain the purpose of the test, 2) provide the test output including the command line used, and 3) give an explanation on what the test has achieved based on the test results.

        It is important that you present a sufficient number of test cases to convince your tutor that your solution works in all situations. Please note that although your tutor may test your program to verify the evidence presented in your documentation, it is not the responsibility of your tutor to test your program for the purpose of finding marks for you. It is up to individual student to mount a convincing case that the submitted solution works as required. You will be be awarded marks based on the test evidences you presented. Therefore if you do not provide test evidence you do not get marks regardless of whether your program works or not. If the test evidence you have provided is not sufficient, your marks will be substantially reduced.

        You should format your test output using fonts such as courier so that test output is clearly distinguishable from the rest of the document. You should not modify the test output unless it is too long and repetitive.

        In presenting your test cases, do not use the tabular format that you may have been told to use in some other units. Simply present one test case after the other in a linear order.

        Source code listing (programming question only) : the source code must be properly indented, commented, and formatted. The source code included in this Word file must be identical to those source code file(s) included in the tar archive.

The documentation requirements described above will be strictly enforced. Your assignment will not be marked, or your marks will be significantly reduced, if you fail to adhere to the above requirements.

Your tutor will mark your assignment directly on your Word file using the "Comment" feature of Microsoft Word. The marked assignment with comments will be returned to you via the Unit LMS.