Chapter 6: Writing Research and Design Reports PDF

Chapter 6: Writing Research and Design Reports Engineers : Neda Al Daher & Fadia ELIssa Chapter 6 Technical Writing & Communication Skills Slide content based on A Guide to Writing as an Engineer , D. Beer and D. McMurry, Wiley: 2014. 4th edition  Topics...

Chapter 6: Writing Research and Design Reports Engineers : Neda Al Daher & Fadia ELIssa Chapter 6 Technical Writing & Communication Skills Slide content based on A Guide to Writing as an Engineer , D. Beer and D. McMurry, Wiley: 2014. 4th edition  Topics Covered Scientific Graduation Research Reports Project Papers Scientific Reports Cover Page Introduction Objectives Material/equipment Discussion Procedure Results Conclusion Scientific Reports/ Cover page Lab’s name Experiment no. Experiment name University’s Logo Date Group number Using MSword Scientific Reports/ Introduction Objectives The objective(s) are what it is you are supposed to accomplish in the experimental procedure itself. The objective(s), therefore, is usually presented in terms of a specific verb that describes what you are supposed to be doing in the lab, such as to measure, to analyze, to determine, to test etc. Material/ Equipment Scientific Reports/ Discussion Procedure Results / Answers to Questions – Visualize your data Scientific Reports/ Conclusion Go over your assignment. Verify that you’ve accomplished all the parts of your assignment so that you can properly address them in the conclusion. Take a few moments to make a list of what you’re supposed to demonstrate or learn in the experiment. Revisit your introduction. To make sure your conclusion is consistent with the rest of your report, revisit your lab report’s introduction. This is a good tactic to help you brainstorm exactly what you’d like to say in your conclusion. Explain: Explain the purpose of the lab. What were you trying to figure out or discover? Talk briefly about the procedure you followed to complete the lab. Results: Explain your results. Confirm whether or not your hypothesis was supported by the results. comment further by describing the meaning of your experiment’s results. Clarify why the results indicate a supported hypothesis or not. iiiiiiiiiii Writing a Documentation Senior Project  Computer Research Template Science Project Template Engineering Design Template  Computer Science Engineering Research Template Project Template Design Template Cover Page Cover Page Cover Page Declaration of Originality Declaration of Originality Acknowledgments Acknowledgments Acknowledgments Abstract Abstract Summary Table of Contents List of Abbreviations List of Abbreviations List of Figures Table of Contents Table of Contents List of Tables List of Figures List of Figures Introduction List of Tables List of Tables Background and Introduction Introduction Literature Review Research Plan Project Plan Design Literature Review Requirements Results Methodology Specification Conclusion and Results and Discussion System Design Future Work Conclusion and Future Implementation References Work Testing Appendix References Conclusions and Future Appendix A Work Appendix B Users’ Manual Mestartingan essaylike 23-00 Ducumentt -MicrosoftWo Home Insert PageLayouT Reference Maleings Rewew View AddDs Acrobat Cut Calibri (Boрy A AaBbCcD Copy Paste B Normal FormatPainter Cipboerd Paragrapih  Main Points Cover Page Declaration of Originality Acknowledgments Abstract List of Abbreviations Table of Contents List of Figures List of Tables 13  Prio Princess Sumaya|Universityfor Technology KingHusseinSchoolfor ComputingSciences Research Title Subtitle (ifany) Prepared By: Student1Name Student2Name Supervised By: Supervisor's Name ResearchSubmittedinpartialfulfillmentforthedegreeofBachelorofScience inComputerScience Semester-Year  Declaration of Originality This document has been written entirely by the undersigned team members of the project. The source of every quoted text is clearly cited and there is no ambiguity in where the quoted text begins and ends. The source of any illustration, image or table that is not the work of the team members is also clearly cited. We are aware that using non-original text or material or paraphrasing or modifying it without proper citation is a violation of the university’s regulations and is subject to legal actions. Names and Signatures of team members:  Acknowledgments Recognition or favorable notice for people. 16  Abstract/Summary Describe your project briefly in few paragraphs. The abstract should not exceed one page. http://www.wikihow.com/Write-an-Abstract 17  Abstract Motivation: Why do we care about the problem and the results? This section should include the importance of your work, the difficulty of the area, and the impact it might have if successful. Problem statement: What problem are you trying to solve? What is the scope of your work (a generalized approach, or for a specific situation)? In some cases it is appropriate to put the problem statement before the motivation, but usually this only works if most readers already understand why the problem is important. Approach: How did you go about solving or making progress on the problem? Did you use simulation, analytic models, prototype construction, or analysis of field data for an actual product? What important variables did you control, ignore, or measure? Results: What's the answer? Specifically, most good papers conclude that something is so many percent faster, cheaper, smaller, or otherwise better than something else. Put the result there, in numbers. Avoid vague, hand-waving results such as "very", "small", or "significant." Conclusions: What are the implications of your answer? Is it going to change the world (unlikely), be a significant "win", or simply serve as a road sign indicating that this path is a waste of time (all of the previous results are useful). Are your results general, potentially generalizable, or specific to a particular case? 18 In a wireless network there are many signals that are Motivation broadcasted; classifying these signals has been of great interest in the past few decades. The main purpose of this study is to estimate the various frequencies of each signal from the bundle of received signals. The receiver monitors the broadcasted signals along with the interfering signals, thus it needs to identify the desired and Problem undesired signals. After estimating the frequencies of the Statement undesired interfering signals, the system can then work on suppressing these signals and maintaining the strength of the desired signals. The suggested new data model system fetches for the frequencies of the received signals. The system contains an adaptive finite impulse response (FIR) filter which exploits one Approach of several random search algorithms, which are the genetic algorithm and swarm intelligent algorithms such as particle swarm optimization (PSO) and ant colony optimization (ACO). After estimating the frequencies a filter will be able to select the Results various frequency components out of a collection of signals and to suppress any interfering signals. The new technique should have advantages over other techniques such as being non- Conclusion parametric, and computationally efficient. 19 Always save the abstract for last 20  List of Abbreviations List the abbreviations you have used in your project if there are any and what they stand for. UML: Unified Modeling Language. JSP: Java Server Pages. DLL: Dynamic Link Library. CMS: Content Management System.  Table of Contents The table of contents should be automatically generated by going to: References >> Table of Contents. Choose Classic as the format of the table and set the number of levels to be 3. In order for the table of contents to be generated correctly: Each chapter title should be formatted using the style “Chapter”. Each section title should be formatted using the style “Section”. Each subsection title should be formatted using the style “Subsection” 22 Headings and SubHeadings  Table of Contents 1. Introduction.................................................................................................................................................. 2 1.1 Section............................................................................................................................................... 2 2 Background and Literature Review............................................................................................................... 3 2.1 This should include:-....................................................................................................................... 4 3 Design.......................................................................................................................................................... 5 3.1 Requirements.................................................................................................................................... 5 3.2 Analysis of Requirements and Constraints.................................................................................. 5 3.3 Different Designs Approaches/choices....................................................................................... 5 3.4 Developed Design........................................................................................................................... 5 3.5 Did the Design Meet Requirements and Constraints................................................................ 6 4 Results......................................................................................................................................................... 7 4.1 Prototype Setup............................................................................................................................... 7 4.2 Experiment/Simulation Setup....................................................................................................... 7 4.3 Experiment/Simulation Results Discussion:............................................................................... 7 4.4 Validation of requirements/constraints....................................................................................... 7 5 Conclusion and Future Work....................................................................................................................... 9 5.1 Appendix A: CODE.....................................................................................................................12 5.2.................................................................................................................................................................13 24  List of Figures The table of Figures should be automatically generated by going to: References >> Index Table of figure Choose Classic as the format of the table and set the tab leader to dots. In order for the table of figures to be generated correctly, the label of each figure should be formatted using the style “Figure”. 25  List of Tables The table of tables should be automatically generated by going to: References >> Index Table of figure Choose Table as the caption, Classic as the format of the table and set the tab leader to dots. In order for the table of contents to be generated correctly, the label of each table should be formatted using the style “Table”. 26 List of Figures List of Tables 27 28 Cross Reference 29  Computer Science Engineering Research Template Project Template Design Template Introduction Introduction Introduction Research Plan Project Plan Background and Literature Review Requirements Literature Review Methodology Specification Design Results and System Design Results Discussion Implementation Testing  Introduction 1. Background of the project (Motivation e.g. why is the design important) 2. Objectives of the project and some description, including the realistic constraints and design requirements. 3. Design achieved (brief description) 4. Indicate who exactly in the group is responsible for what. 5. Organization of the rest of the documentation. 31  Product Design Constraints and Requirements ❑ Design Engineers must consider a multitude of technical, economic, social, environmental, and political constraints when they design products and processes. ❑ Theremust be clear evidence in your design project that you have addressed the constraints that are relevant to your project.  Realistic Constraints Examples Performance with cost/environmental restrictions Accuracy / precision in determining properties ( need to do simulation for certain applications) Health and safety concerns 33 Design Requirements  Design Requirements If you are designing a baseball bat, your design requirements might be that the bat needs to be: – Less than 1.5 pounds. – Made out of a material approved by the league. – Able to hit a baseball without breaking. If you are designing a better form of transportation for students to get to school, your design requirements might be that the transportation needs to be: – Free for students. – Quick: less than one hour round-trip. – Safe. 35 Design Types of Design Requirement for Requirements General Products Types of Design Requirements for Software Programs 36  Types of Design Requirements for General Products Performance characteristics Physical Characteristics Aesthetics Cost Inputs Energy consumption Fuel consumption Outputs Product produced Power Pollution Undesirable side effects Environmental requirements Ease of use Ease of learning 37  Types of Design Requirements for Software Programs Functionality or feature set Speed, responsiveness Programming language written in Portability (ability to move to another operating system) 38  Background and Literature Review Review and contrast 5-7 conference or journal papers discuss similar problem Include references Highlight any requirements or constraints of published work Highlight your contribution to previous work Brief description of the used technologies, equipment, circuits, design, …etc (Background) 39 Design 40  Design Requirements Analysis of Requirements and Constraints Both pre specified and based on requirements analysis Different Designs- Approaches/choices Developed Design (VISIO) Flow charts Schematic Pseudo codes System level diagrams Architecture diagrams System/transistor diagram Did the Design Meet Requirements and Constraints Use table to summarize requirements and constraints met with justifications 41 42  Results Prototype Setup Hardware software Experiment/Simulation Setup Experiment/Simulation Results Discussion Tables Graphs Waveforms figures Validation of requirements/constraints Discuss and analyze whether the requirements and realistic constraints are met 43 Future Work and Conclusion The conclusion should draw out the implications (a conclusion reached on the basis of evidence and reasoning) of findings and any possible future work. Conclude Summarize Generalize 44  Future Work and Conclusion 1. Tie together, integrate and combine the various issues raised in the discussion sections and the solution presented whilst reflecting the introductory thesis statement (s) or objectives 2. Provide direction and areas for future research 45  Appendix and Code supporting evidence (e.g. raw data that is referred to in the text) contributory facts, specialized data (raw data appear in the appendix, but summarized data appear in the body of the text.) sample calculations (referred to in the text) technical figures, graphs, tables, statistics (referred to in the text) specification or data sheets (summarized in the text) TimeLine Timeline 47 NEATNESS counts! 48  Common Mistakes Try not to use I and we …. Example X After working we discovered that … ✓ It was discovered from the above results that ….. Resolution 49 Be smart in marketing and presenting your work! Documentation and Presentation! 50 51  Hand in Samples of CS and Engineering Projects’ templates Writing a Scientific Paper In academic publishing, a scientific journal is a periodical publication intended to further the progress of science, usually by reporting new research. Writing a Scientific Paper Report original empirical and theoretical work within a scientific field Why publish? -Academics and researchers -Graduate students How to value publications Peer Review Citations http://slideplayer.com/slide/6295386/ Proposals Research Papers vs Project Proposals 55 Proposals Research Papers Structure 56 Proposals Publication Process 57 Proposals Research Proposals Cycle 58 Proposals Research Proposals Structure 59 Proposals Research Proposals Process 60 Primary Scientific Publications Scientific research on original work Authors present their own research work Published in Scientific Journals Conference Proceedings Technical reports Book Chapters Secondary Scientific Publications Surveys on research work. Authors present a synthesis of research articles on a topic to highlight advances of research. Published in Review journals Books or compilations of articles. What is an In-Text Citation? An in-text citation provides brief information within the body of your writing, letting the reader know where the information or idea comes from. It points to a more detailed source listed at the end of the document. What is a Reference Citation (Full Citation)? A reference citation is the full, detailed information about a source, which appears at the end of your work in a section like References (It allows readers to find the exact source you used.)  Journal article citation author article date title Schoeman,H. (2009). Establishingaprocess forthe creation ofgenetically modified bacteria.Canadian JournalofMicrobiology,55(8),990-1002. doi:10.1139/W09-039 pages journal volume issue title Digital ObjectIdentifier(doi) orjournalURL Editors Conference Title BookTitle PacakK,Aguilera G,Sabban E,KvetnanskyR,editors. Stress: current neuroendocrine andgenetic approaches. 8th Symposiumon Catecholamines and OtherNeurotransmitters in Stress; 2003 Jun,28 Jul 3; Smolenice Castle, - Slovakia. NewYork:NewYorkAcademyofSciences; 2004 Jun. 590 р. Place of Publisher Date of Date of Pagination Place of Publication Conference Publication Conferencе Hand in IEEE papers’ format And a paper sample Research Gate PSUT Electronic Libraries - Google Scholar Assignment 3 67 Teamwork Limited time Each has a distinctive role leading either to the team’s Success or failure. Limited Resources Communication is essential. 68