Scribd
Upload
54 views

Report Writing Tip

The document provides guidelines for producing a formal project report, including: - The report should be at least 10 pages and follow the structure of a formal report. - It should describe the design, implementation, verification, and division of tasks between group members. - Sections should include an introduction, specification, implementation, verification, coding, and appendix. Figures and tables should be placed near their mention in the text.

Uploaded by

Zhennan Wang
Copyright
© Attribution Non-Commercial (BY-NC)
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
54 views

Report Writing Tip

The document provides guidelines for producing a formal project report, including: - The report should be at least 10 pages and follow the structure of a formal report. - It should describe the design, implementation, verification, and division of tasks between group members. - Sections should include an introduction, specification, implementation, verification, coding, and appendix. Figures and tables should be placed near their mention in the text.

Uploaded by

Zhennan Wang
Copyright
© Attribution Non-Commercial (BY-NC)
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 2

You

are asked to produce a document describing you project. The report should be done up to the standards of a formal report. Further, in documenting your design and verification schemes, you should make sure that you applied all the procedures introduced in the class. Finally, in preparation of the report you may find useful the following hints. 1) Size of the report Each group should produce the report no shorter than 10 pages. This includes all write up as well as the simulation result, codes, code descriptions etc. There is no upper page limit of the report. 2) Structure of the report a) Title Page This page must contain the title of the project, authors' names and signatures, McGill IDs and date of submission. These should be properly centered on the page and occur in the order listed. b) Table of content including listing of all tables and figures ALL pages in your report must be numbered consecutively from the INTRODUCTION including the APPENDICES. The leading pages usually are given Roman Numerals. Make sure the listing is properly aligned and fills the entire page(s). It is useful to use dots (or other methods) to couple the section name to the page number for easy visual alignment. c) Introduction Introduction section starts the report. In this part you shortly introduce your design and the hardware you used in its implementation. d) Task division List all the tasks each of the group member was responsible for in the design, implementation and the verification process. e) Specification In this section you describe the specification of your design. Put the special emphasis on the elements typical to your design implemented in the Final Project lab. Explain your motivations behind the selection of the features you implemented in the contents of the available hardware. f) Implementation Describe in details your implementation. Put the particular emphasis on the use of the available hardware in your design. Describe the limitations of the hardware and eventual simplifications you had to make in your

Final Report

g)

h)

i)

j)

design. How would additional hardware influence your design choices? Make sure that you document all the steps well enough for the third party to understand your steps. Verification Describe in details the verification scenario. Document well all the test cases you used to check the correctness of your design, and motivate their selection. Discuss the simulation results. In cases, when the simulation of the hardware differ from these in the software, discuss what could be the causes of such discrepancies. Are the differences acceptable, or they need to be fixed in the future and how? Coding All codes (design and verification) should be well documented. Remember to put comments inside the code, even if you are going to describe the code in the report. Appendix This is an optional part. If you do not put all the generated codes in the previous chapters, then you should deposit them here. If needed you can add some explanations. Chapters structure In general each chapter will have subsections. Use the appropriate and consistent numbering. Remember to align your text. Justified is the proper alignment. Use the fond of your choice, however Times Roman is one of the most popular in the reports. Use size 12p. fond, as well as double line spacing. You will most likely use Word processor for typing your report. Make sure, that figures and tables are inserted very close (preferably on top of) the place in text, where you refer to them for the first time. If you talk about the figure, which is placed four pages further in the text, then this makes reading really very difficult. Try to reduce the largerthanpagesize material to page size. Otherwise use a logical (simple) folding and binding procedure. Make good use of block diagrams to explain your concepts.

You might also like

pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy