Documenti di Didattica
Documenti di Professioni
Documenti di Cultura
2010 by Informatics Academy International A Division of Informatics Education Ltd. Informatics Campus 12 Science Centre Road Singapore 609080
All rights reserved. No part of this publication may be reproduced, stored in a retrieval system, or transmitted by any form or means, electronic, mechanical, photocopying, recording, or otherwise, without prior written permission of the publisher. Every precaution has been taken by the publisher and author(s) in the preparation of this book. The publisher offers no warranties or representations, and does not accept any liabilities with respect to the use of any information or examples contained herein. All brand names and company names mentioned in this book are protected by their respective trademarks and are hereby acknowledged. The developer is wholly responsible for the contents, errors and omission.
2|Page
Table of Contents
CHAPTER 1: GENERAL GUIDELINES .......................................................................................... 5
1.1 INTRODUCTION............................................................................................................................................................ 5 1.2 ASSIGNMENT PREPARATION GUIDELINES ................................................................................................................. 6 1.3 WRITING GUIDELINES ................................................................................................................................................. 8 1.4 ASSIGNMENT LAYOUT GUIDELINES ............................................................................................................................ 9
3|Page
4|Page
5|Page
Many students tend to plunge straight into doing the assignment without the proper understanding of the requirements or guidelines. You should check those requirements or guidelines before starting your preparation, and revisiting these requirements or guidelines during the preparation. You should not make assumptions on the requirements or guidelines that you do not fully understand. If you feel uncertain, always consult your lecturer. Some assignments may consist of a few topics or questions from which you can choose. You should select the topic or question that interests you most. You could consult with your classmates or even with your lecturers if you are uncertain about choosing the best topic for yourself. Once the topic/question is chosen, you must analyze it carefully. You should ask yourself questions such as What are the main issues? and What does the question require you to do: to explain, evaluate, analyze etc... The meaning of each term in the question must be understood fully.
6|Page
Next, you should gather your information from different sources. While the Internet is one of the best (most convenient?) sources of information that students rely on, many are tempted to do cut-andpaste jobs for their assignments without realizing that the plagiarized work can be easily detected. You should keep track of the web sites you have visited and information you have downloaded so that you can retrieve them effortlessly when required. You also must remember to quote those web sources in reference section as use of such information without acknowledgement is considered as plagiarism. There are inexhaustible amount of information you can find on the Internet which may be related to your assignment topic. You must analyze and decide which information you should use and which information you should discard based on the requirements as well as expectation of your assignment. After all necessary information has been gathered, it is time for you to start preparing the outlines of your assignment. Usually the assignment guidelines will include the format and structure of the report. Based on the given format and structure, you can outline all the topics. Then you should organize your assignment by writing notes for each part of the assignment (e.g. introduction, body, conclusion, etc.). Writing the assignment comes next and you must always use a good academic writing. You should not write your assignment the same way that you speak. Writing of assignment will be discussed in detail in the next chapter. It is always advisable to review your work after finishing. You may even ask your lecturer to review your draft assignment to check any missing topics or mistakes. If you plan your work properly and follow your plan strictly, you can definitely submit your assignment on time. You should strive to submit your assignment before the deadline. Your lecturer will appreciate the timeliness, and an early submission (with a reasonably good piece of work) will leave a good impression with your lecturer and your effort will be appreciated.
7|Page
Use of tables, figures, and graphs The following guidelines should be adhered to when using tables, figures, and graphs. They must have clear and defined purposes and they must be referred to in the body of your assignment. You should ensure that captions or titles are clear to understand and they are set in bold. They must be numbered and referred in the text rather than using above or below (E.g. Table 2.1, Figure 1.0, etc) The numbering should follow paragraph numbering. For example, in chapter 3, all tables should be numbered 3.1, 3.2, 3.3 etc. in sequential order.
8|Page
9|Page
Chapter 2 Referencing
10 | P a g e
Chapter 2: Referencing
2.1 Introduction
The main objective of referencing is to acknowledge the intellectual property of others and thus to avoid plagiarism. Referencing includes the original authors name and particulars of the book (for printed material) or website (for electronic material). Apart from acknowledging original ideas of others, referencing indirectly prove that you have read extensively on the topic. By proper referencing, you demonstrate that your work has enough depth and scope required by the assignment question. Referencing also allows reader to locate your original source of material.
11 | P a g e
2.2 Plagiarism
Plagiarism, which can be defined as using another persons words or ideas without giving acknowledgement, and submitting them for assessment as though it were ones own work. This includes copying, translating from one language to another or unacknowledged paraphrasing. If you use someone elses ideas in your assignment, you must acknowledge that these are not your own original ideas by giving appropriate referencing. You commit plagiarism when considerable portion of work by others are copied directly and they are not appropriately referenced. Even if you change few words of what original author says, you must acknowledge that the idea comes from someone else. This is called paraphrasing. You can be accused of plagiarism when ideas and observations of others have been used and material is paraphrased or summarized without appropriate referencing. Further examples of plagiarism are given below: (i) Use of any quotation(s) from the published or unpublished work of other persons, whether published in textbooks, articles, the Web, or in any other format, which quotations have not been clearly identified as such by being placed in quotation marks and acknowledged. (ii) Use of another persons words or ideas that has been slightly changed or paraphrased to make it look different from the original. (iii) Summarising another persons ideas, judgements, diagrams, figures, or computer programs without reference to that person in the text and the source in the bibliography. (iv) Use of services of essay banks and/or any other agencies. (v) Use of unacknowledged material downloaded from the Internet. (vi) Re-use of ones own material except as authorised by the department.
12 | P a g e
Dealing with Plagiarism Students are required to submit their assignments to plagiarism checking software (e.g. mydropbox.com, turnitin.com, etc.), and to include the report that they get from the software with their assignment. Guidance as to how they should interpret that report is as follows: If you have a matching percentage of 20% or less, you can submit the coursework as it is. If you have a matching percentage between 21% and 50%, you must check carefully that you have properly cited ALL the text that is identified as coming from other sources (this is usually all the coloured text). If you have a matching percentage between 51% and 69%, it is likely that your coursework does not contain enough of your own ideas. You need to carefully review your use of sources, check they are cited correctly and you may need to rewrite some sections of your work. If you have a matching percentage between 70% and 79%, there is not sufficient material of your own in the coursework. As well as carefully reviewing your use of sources and checking they are cited correctly you will need to rewrite some sections of your work, using your own words and ideas. If you have a matching percentage of 80% or more, your coursework is not acceptable. You MUST rewrite it in your own words correctly citing any sources you use. You MUST resubmit your rewritten coursework to mydropbox.com 24 hours before the final coursework deadline in order to include both plagiarism reports when you submit your coursework.
13 | P a g e
Collusion Although it is acceptable and encouraged to share ideas with your peers, all assignments must be the work of individuals, unless group projects are specifically mentioned in the guidelines. It is not acceptable for two or more students to submit identical work. This is considered an act of collusion, and such cases will be dealt with seriously, and may result in a failed grade. Collusion cases can be easily detected by lecturers by observing identical layout, identical mistakes, identical argument and identical presentation. You can discuss your ideas with your classmates to get informal feedback on your work. But you must protect your work from intentional or unintentional copying by other students. You must never lend your assignment to other students before submission. Providing your work to other students with the intention of assisting them is also considered as an act of collusion. Your files (e.g. word document, program listing, etc.) relating to assignment must be secured so that they cannot be viewed by other students.
14 | P a g e
II. Harvard Referencing for Books 1. 2. 3. 4. 5. List authors in the order they are given on the title page, with family names first followed by the initial of given names. Give the year the book was published. This is the most recent copyright date, and NOT the printing (or reprinting) date. Give the full title of the book in italics. Give the city in which the book was publish followed by a colon. Give the name of the publisher.
Example: Rollings, A.& Adams, E., 2003. Andrew Rollings and Ernest Adams on Game Design. Berkeley, California, USA: New Riders
15 | P a g e
III. Harvard Referencing for Journal Articles 1. 2. 3. 4. 5. Example: Capkun S. & Hubaux J., 2006, Secure positioning in wireless networks. IEEE Journal on Selected Areas in Communications, 24(2):221232. List authors in the order they are given on the title part of the article, with family names first followed by the initial of given names. Give the year the article was published. Give the full title of the article. Give the name of the journal in italics. Give the volume and part of the journal followed by the page numbers of the article.
1. 2. 3. 4. 5. 6. Example:
Write Anon. for anonymous (author unknown) Give the year the article was published. Give the full title of the article. Give the name of the journal in italics. Give the date the article was published. Give number of page numbers of the article.
Anon., 2007, Hazard of Microwave Radiation. Asia Telecommunications, (20 Nov), 12.
1. 2. 3. 4. 5. 6.
List authors (if available) in the order they are given on the title part of the article, with family names first followed by the initial of given names. Give the year the article was published. Give the full title of the article followed by [online]. Give the name of the website publisher in italics. Write Available at followed by website address Give the date that you accessed the website
Example: Roberts, J., 2005. Starting Mobile Applications with C#. [online]. CoderSource.Net, Available at http://www.codersource.net/asp_net_mobile_first_app.aspx [Accessed 19 May, 2008]
16 | P a g e
17 | P a g e
All reports should follow proper structure so that readers can read and understand the document easily. A formal report should contain the following sections. 1. 2. 3. 4. 5. 6. 7. 8. 9. 10. Cover Sheet Title Page (for project only) Abstract Table of Contents Introduction Body Conclusions List of References Bibliography (if necessary) Appendices
Note: This is a general guideline and you should follow the instructions given in the assignment or project guidelines.
18 | P a g e
19 | P a g e
Figure 3.2
20 | P a g e
3.4 Abstract
An abstract is a brief (normally 200 words or less) summary of the essential contents of the report. It is placed before the body of the report so that the reader may decide from it whether to read the full report or not. In practice, the abstract often exists apart from the report in library collections and can make decisions as to what reports are needed to complete their research. A summary (often called an executive summary) is sometimes used in place of an abstract when attached to the report. A summary will never exist separately from the report, however. The abstract should include brief statements of the objectives, the method used to satisfy the objectives, significant results (normally one or two), and conclusions. Figures and tables should not be referred to in the abstract, and equations normally should not be used. It is usually best to write the abstract last, scanning the report body for essential information and presenting this information in as few words as possible. An example of typical abstract with the essential elements identified is given below.
The World Wide Web has provided a strong medium for networked computing with independent platform. As the Internet continues to grow, there will be a practical as well as economical sense to connect number of devices to the Internet. Hence, embedded web servers are needed to access, monitor, and control these devices. This work investigated the issues involved in developing an embedded web server which monitors and controls a number of devices through its re-configurable I/O ports. This thesis also provides detail discussion on the software and hardware aspects of an embedded web server. Site Player embedded server module was used as a base unit in this research. With the PC interface, embedded server module was configured with appropriate I/O control codes as well as user interface. The example application used with the embedded server module was a servoservodriven robot arm which has four servo motors to control the movements of its base, arm, wrist, and grip. Further integration and greater capability of web-enable devices which are being used in factory automation and home appliances control were discussed as future works of this research.
Figure 3.3
Example of Abstract
21 | P a g e
TABLE OF CONTENTS Abstract 1. Introduction 2. Current System (if any). 3. Proposed System 4. Specifications 4.1 Input Specification 4.2 Screen Design 4.3 Program Design 4.4 Validation and processing 5. Program Listing 6. Testing 6.1 Test Plan 6.2 Test Cases 6.3 Test Log 6.4 Screen Dumps 7. Implementation 7.1 User Manual 8. Conclusion 8.1 Strengths 8.2 Weaknesses 8.3 Enhancements List of References Appendices Appendix 1 Appendix 2
Page i 1 2 3 4 4 6 8 11 15 30 30 34 36 40 45 45 55 55 56 56 57 59 61
22 | P a g e
3.6 Introduction
The primary purpose of the introduction is to provide the necessary background on the subject, to describe the objectives of the work accomplished, and to define the method and scope of the report. The introduction should identify the aim of the assignment or project and include the reason for doing the work. Figures and tables should not be used in the introduction. The introduction should be approximately one typewritten page, but the length can be either longer or shorter depending on the subject being introduced.
3.7 Body
The body of a report is the main part and it contains discussions and analysis. The contents must be presented in logical sequence, using appropriate paragraphing. Each paragraph should contain one main idea. Whenever new ideas or new directions are presented, they should be placed under new headings or sub-headings. You must ensure that your research findings and proven facts must be used to support your discussions. The following self-test questions should be answered to have a well thought discussion. How do you find out about this? Why is this so? Why do you make such opinion? Why do you select this solution / process / design?
23 | P a g e
3.8 Conclusions
Conclusions reached during discussions and analysis in the body of the report should be restated here in a more general, less specific manner. Conclusions are normally listed in the order of their importance, preferably in itemized form, although a narrative presentation is completely satisfactory. Already known facts should not be included in this section, and conclusions should not be confused with factual test or experimental results. If conclusions are qualified, give the assumptions and limitations that apply. No new information should be introduced in this section. The conclusions provide a quick reference for the reader with limited time. Often a reader will only read the abstract and the conclusions sections of the report. Thus it is imperative that conclusions be stated concisely and accurately, with whatever qualifications that apply. There should not be discussion in the conclusions section but the significant thoughts from discussion in the previous section can be extracted.
3.10 Bibliography
A bibliography is an alphabetical listing of all the sources of information that you have read, used or referenced when researching and preparing the report. Although most assignments do not require bibliography, it is a good practise to include it if you are writing report for a project.
24 | P a g e
3.11 Appendices
Appendices are used to provide supporting data that are not significant enough to be included in the body of the report. In this manner the body of the report can focus on material essential to the discussion and conclusions, and readers will not be distracted by supporting information of little importance in the main body of the report. Less important information can be included in the appendix without cluttering up the more significant portions of the report. Because only serious readers are usually interested in the data included in the appendix, the distribution of the full report (including appendix), is sometimes restricted to only a few readers. This decision is, of course, also a function of the relative size of the appendix. Some information associated with the test effort is of so little interest and importance that it should not normally be included in the report or in the appendix. Each separate item should be included as a separate appendix (for example, Appendix A Program Listing, Appendix B ASCII Conversion Table).
25 | P a g e
26 | P a g e
27 | P a g e
28 | P a g e
Body: The body is the meat of the presentation and corresponds generally to the results and discussion section of the written report. As is true of the written report, the body of the presentation should be supported with an adequate number of visual aids. Figures showing curves, drawings, or sketches are preferred over tables, which often contain too much information for the audience to grasp during 30 to 60 seconds that a visual aid is normally projected. The body of the presentation should include the information necessary to substantiate the conclusions of the effort being reported on. The flow of this part of the presentation should be such that the audience can easily follow the evolution of the effort from the first steps and findings to the final conclusion. Conclusion: The conclusion of an oral report should include a summary of what has been presented. Conclusions can be listed individually and discussed briefly, emphasizing the importance of major findings. If recommendations are appropriate, the conclusion is the place to include them, as well. The important thin to keep in mind here is that statements made at the conclusion of the presentation are ones most likely to be remembered by the audience. The presentation should be concluded dynamically, leaving the audience with the most important conclusion, suggestion, and recommendation.
29 | P a g e
Relating personal experiences that support the presentation theme is also a good technique. Tying the various parts of the presentation together so that there is a logical flow is essential. The audience should always know where you are and where you are going in relation to the subject of talk at all times. Most importantly, you must always stay in character and be yourself. Finally, a strong closing should always be made. If the presentation ends by just trailing off with thats all I have or thank you, the audience will probably not be persuaded by the speaker and will certainly not feel a strong impetus to support the thesis of the presentation. The presentation should end with a strong summary of what has been discussed, emphasizing the points of greatest importance.
30 | P a g e