EE-446 Embedded Systems Design Design Project Guide: Document Organization
EE-446 Embedded Systems Design Design Project Guide: Document Organization
EE-446 Embedded Systems Design Design Project Guide: Document Organization
Document Organization
Design Project Schedule Design Project Overview Deliverables Grading Design Project Proposal Guidelines Design Project Report Guidelines
at an appropriate stage, you can also choose a PSoC for your project (You must keep in mind that the labs of PSoCs will be introduced to you during the last weeks of the semester, so you might start researching on them if you are choosing a PSoC for your project). Phase 1: By the end of Phase 1, design teams should have completed roughly 20% of their overall design goals (the main simulations) and verify this through the standard check-off procedure. Phase 2: Although you are free to organize your efforts as you wish, by Phase 2, roughly 50% of your tasks should be completed including, the coding of the microcontroller/PSOC and some functioning hardware etc. Phase 3: By Phase 3 you must show the complete hardware. Phase 1-3 check offs must be performed with a TA by the dates listed above. Ideally all team members will be present, but fewer can do the check offs if necessary. Reports will be written according to the guidelines covered below and must include specific information defined in the Project Description. Project reports must be submitted electronically on LMS in addition to the printed copies. Project reports can be submitted any time after the Final Demo but must be turned in within one week of Final Demo.
Deliverables
Design Project Proposal Each group must write a Design Project Proposal which briefly but thoroughly outlines the teams plan to complete the project. Details are provided below. You must first submit a draft proposal and then meet with the TA sometime that week to discuss your draft proposal, receiving feedback you will use to complete the final proposal. You will need both a Phase 1 Grading Sheet and a Proposal Grading Sheet when you meet with the TA. Final Demonstrations Demonstrations to the instructor will take place in a lab and should be attended by all team members. The team should prepare for the demonstration BEFORE the scheduled time. The team will be given ~10 minutes to present. Following this, each member of the team will individually be given 1-2 minutes to describe his/her contributions to the design project. Project Report The final project report should be as brief as possible while still providing the required information in a well-organized and informative manner. Specific guidelines for the team-generated report are
given below. The quality and completeness of your design project will be based in large part on Phases 1-3. Please submit reports electronically to Dr. Awais by the deadline above in addition to the printed reports. Grading 20% Quality of Proposal 45% Final Demo Evaluation 25% Report Quality 10% Individual Effort
Outline the tasks that you plan to complete highlighting the tools and methods that will be used to accomplish your goals. This section will be the bulk of your proposal and should demonstrate your team has thoroughly considered the project and knows what needs to be accomplished to complete the project. (Half page Max) Work Plan Schedule Provide a full list of everything that will be completed for your project. For planning purposes, this list should be as detailed as possible. Indicate which team members will be primarily responsible for each task. Specify which tasks will be completed during each phase of the project (Phases 1-3). The table below shows how you could organize this information, but you are not required to follow this exact format. You should plan to complete everything by Phase 3.
Briefly describe the circuit that was constructed and include diagrams with captions as appropriate. Summarize project goals and design logic in your own words. You may use what you have prepared for your proposal, modified if necessary.
Design Methodology and Results (3-4 pages) Describe your approach to meeting the design logic. Outline the unique and challenging aspects of your project and how you worked to meet those challenges. Discuss your design preparation / planning. Typically this section should be presented in the order you completed your design and project, starting with the initial simulation and coding and building up to the hardware. Conclusions (1/2 -1 pages) Briefly summarize your design effort and measurement results. Comment on ways to improve your design if you know of any. Do not introduce new information in this section.
Note: The code can be embedded into the document or put into an appendix but all figures should have appropriate captions and be referred to within the text. A figure that is not discussed in the body of your report and is without a caption will be ignored.
Report Formatting The type-written final reports should adhere to the following format guidelines: Section headings and subheadings should help the reader to follow the organization of your report and should be formatted consistently throughout your report. Font size should be 10pt or larger Line spacing can be single spaced or 1.5 line spaced Margins should be 1 on all sides Include page numbers at the bottom of each page after the first (title) page; manually numbering appendix page numbers is acceptable