1 / 30

Technical Reports

Technical Reports. ELEC422 Design II. To gain experience in the process of generating, disseminating, and sharing of technical knowledge in electrical engineering discipline To promote a lifelong endeavor of acquiring knowledge through reading, understanding, and applying new materials

trula
Télécharger la présentation

Technical Reports

An Image/Link below is provided (as is) to download presentation Download Policy: Content on the Website is provided to you AS IS for your information and personal use and may not be sold / licensed / shared on other websites without getting consent from its author. Content is provided to you AS IS for your information and personal use only. Download presentation by click this link. While downloading, if for some reason you are not able to download a presentation, the publisher may have deleted the file from their server. During download, if you can't get a presentation, the file might be deleted by the publisher.

E N D

Presentation Transcript

  1. Technical Reports ELEC422 Design II

  2. To gain experience in the process of generating, disseminating, and sharing of technical knowledge in electrical engineering discipline • To promote a lifelong endeavor of acquiring knowledge through reading, understanding, and applying new materials • To become familiar with IEEE publication standards and paper template Objectives

  3. IEEE Transactions & Journal articles • Conference Proceedings • Edited Books • Technical Reports • Theses & Dissertations • Internet & the World Wide Web Sources of Knowledge

  4. Title • List of Authors • Abstract • Introduction • Theoretical Analysis • Methods (Apparatus & Procedures) • Results • Discussion • Conclusions • Acknowledgements • References • Appendices Elements of Technical Reports

  5. A short, informative description of the essence of the report • Contain the fewest number of words (40 characters or less) • Readers use the title to determine initial interest in the paper • Names of people with active role are listed Title & A List of Authors

  6. A summary of the entire report in 250 words or less • Contains scope and purpose, a short description of the methods, results, and conclusions • No literature citations or references to figures Abstract

  7. Concisely states what motivated the study • Consists of two primary parts • Background or historical perspective on the topic (inconsistencies, unanswered questions, or new questions to set the stage for the present study) • Statement of objectives of the work Introduction

  8. Provide the development of appropriate equations and/or numerical techniques • Mathematical expressions presented in a consistent style • Equations have a right-aligned sequential number in parentheses Theoretical Analysis

  9. Provides sufficient detail to allow another technically-trained individual to replicate the analysis and/or experiment • Description of any specialized apparatus, instrumentation, data acquisition, and any specialized measurement methodology Methods

  10. Apparatus & Procedures Enough description that the experiment could be reproduced by anyone in the field Sequential in narrative style (i.e., no bulleting or numbering) Write in third person, past tense, passive voice.

  11. A summary of the findings from the study or experiment • Expected to have two components • A body of text describing the results • Visual elements (graphs, figures, and tables) to help visualize the data Results

  12. Interpretation and possible explanations of the results (‘big picture’ view) • Summarize why the results support the conclusions • Describe inconsistencies in the data • Discuss possible sources of error • Describe the impact on the state of knowledge • Suggest future extensions of the current work Discussion & Conclusions

  13. Acknowledge people and organizations that facilitated the study • The heading not numbered Acknowledgements

  14. Outside sources consulted in preparing the paper • Typically cited in the Introduction, Methods, and Discussion sections • Refer to earlier method that was modified in the current work • Refer to prior premise used as a basis for current analysis References

  15. Contains extra material not essential, but may be helpful to anyone trying to replicate the study • Detailed theoretical derivation • A tabulation of data to be used as a benchmark test for future development Appendices

  16. Basic Requirements Succinct and clearly written. Sufficient description to enable an engineer familiar with basic electrical measurements to reproduce your results. Printed output from a word processor. Figures prepared by software. Proper grammar, punctuation, spelling expected

  17. Formatting Typed in 10 or 12 point type formulae typeset using an equation editor Same font and form for all headings. One inch left & right margins Cite your source as a reference (a number in square brackets, e.g. [1]) A list of references at end of report (IEEE)

  18. Tables & Figures Tables and figures must have a title, a number, and a caption (above for table, below for figure). Referenced in the text by title and number Specify unit of measure associated with variable Use table when there is no relation between subsequent datum

  19. Present your design project in the form of a technical report previously described • Start early and allow time for editing and proofreading (Revision) • Strictly follow instructions in IEEE template • Writing style clearly understood by your peers (people with similar training) • Keep the tone factual and objective CEEDS Paper

  20. Two-column format (IEEE standards) • 6-page limit • Submit the first draft to your project advisor & course instructor by 22 March 2017 (paper only) • Final version due by Monday, 17 April 2017 (both electronic and paper) CEEDS Paper

  21. http://www.ieee.org/conferences_events/conferences/publishing/templates.htmlhttp://www.ieee.org/conferences_events/conferences/publishing/templates.html IEEE Standards & Templates

  22. Paper evaluated on three criteria: organization (format), quality of writing, and completeness • The paper counts 10% of total grade • 5% for oral presentation • Input from project advisor & other faculty members Grading

  23. One-column format • 12-point Font of your choice • 12-point Courier New Font for Source Code • No limit on # of Pages • First draft due by Wednesday, 5 April 2017 (paper only) • Final version due by Wednesday, 19 April 2017 (both electronic and paper) Final Report

  24. Cover Page • Table of Contents • Abstract • Acknowledgement • Problem Statement • The Requirement ( Engineering) Specifications • The design • Design Verification & Testing • Summary and Conclusions • References • Appendices Final Report Outline

  25. Need Identification • Objective statement • Background & Research Survey • Marketing Requirements • Objective tree Problem Statement

  26. Functional Decomposition • Level 0 Design • Level 1 Design . . . . • Level n Design • High-level Software Description • Defer in-depth Details to Functional Specifications The Design

  27. Unit testing • Integration Testing • Acceptance Testing Design Verification & Testing

  28. Functional Specifications • Personnel & Summary of qualifications (Resumes) • Budget & Bill of Materials • Competition Rules (if any) • A Copy of CEEDS paper • A Copy of the Source code Appendices

More Related