Difference between revisions of "Engineering Notebook"
Jbringardner (talk | contribs) |
Jbringardner (talk | contribs) |
||
| Line 1: | Line 1: | ||
<!--== Google Drive Folder Setup == | = Engineering Notebook = | ||
As you are working on your semester-long design project, it is critical that you maintain a record of your work and progress. In order to help create your Milestones and Final Presentation, as well as maintain your project schedule, the notebook should be updated regularly. | |||
In order to pass a project Benchmark assessment, or to complete your final Submission, your notebook must be fully updated and deemed satisfactory by a TA. <!--The notebook must additionally be submitted in a Word Document (DOC or DOCX) format prior to each Benchmark deadline on the [[eg.poly.edu EG1003 website]] under the Submission tab.--> For Milestone 2, Milestone 3, and Final Submission you must have it approved by an Open Lab TA <!--submit your notebook--> in a Word Document (DOC or DOCX) format. One engineering notebook needs to be maintained for a group. | |||
== Google Drive Folder Setup == | |||
At the beginning of each semester, each semester long design project (SLDP) team will create a Google Drive folder for documenting all of the work on their project. The folder will be shared with the recitation professor, recitation TA, RAD mentor (if applicable), and the lab TAs. The link to this folder must be uploaded to the EG Website submission page for SLDP Folders by the due date of the Milestone 1 presentation. This folder will contain a Google Doc for your engineering notebook and all other files used for your SLDP including but not limited to presentations, CAD files, code, circuit diagrams, pictures, budget spreadsheets, Microsoft Project schedule files, Preliminary Design Investigation, and Final Design Report. '''The engineering notebook should be used as documentation and an outline for the Milestone presentations, final presentation, and Final Design Report.''' | At the beginning of each semester, each semester long design project (SLDP) team will create a Google Drive folder for documenting all of the work on their project. The folder will be shared with the recitation professor, recitation TA, RAD mentor (if applicable), and the lab TAs. The link to this folder must be uploaded to the EG Website submission page for SLDP Folders by the due date of the Milestone 1 presentation. This folder will contain a Google Doc for your engineering notebook and all other files used for your SLDP including but not limited to presentations, CAD files, code, circuit diagrams, pictures, budget spreadsheets, Microsoft Project schedule files, Preliminary Design Investigation, and Final Design Report. '''The engineering notebook should be used as documentation and an outline for the Milestone presentations, final presentation, and Final Design Report.''' | ||
== Notebook Guide == | == Notebook Guide == | ||
Engineering notebooks | Engineering notebooks allow engineers to track and document their efforts. In turn, engineering notebooks can be used to assess each team member's contributions to the project and who owns the intellectual property. Engineering notebook should be updated weekly, and kept organized and legible for sharing with the team. | ||
The engineering notebook include: | The engineering notebook include: | ||
*Preliminary Design Investigation | |||
*Meeting Notes | *Meeting Notes | ||
*Tracking of items for which you are responsible | *Tracking of items for which you are responsible | ||
*Deadlines for you | *Deadlines and tasks for you and the team | ||
*Technical Notes | *Technical Notes | ||
*Designs, sketches, software code, and any other artifacts created for the VIP team | *Designs, sketches, software code, and any other artifacts created for the VIP team | ||
*Screenshots or pictures of your design | |||
*Include the artifact itself, or where to find it (e.g., URL to repository) | *Include the artifact itself, or where to find it (e.g., URL to repository) | ||
*Record and briefly describe important resources (websites, books, people) | *Record and briefly describe important resources (websites, books, people) | ||
*Your ideas, brainstorming, questions, and general thoughts (even if not developed) | *Your ideas, brainstorming, questions, and general thoughts (even if not developed) | ||
*Updates to cost or project schedule | |||
*Plans for the future and to-do lists | |||
The format of the EG 1004 Project Notebook is a Google Doc with chronological entries | The format of the EG 1004 Project Notebook is a Google Doc with chronological entries | ||
== Milestone assignments == | == Milestone assignments == | ||
The following assignments will be completed during recitation on the days of the milestone presentations. A picture or scan of the documents below should be included in your engineering notebook. | |||
=== Design Thinking === | === Design Thinking === | ||
IDEO is an organization that aims to supports designers with methods and strategies for critically thinking about the design process. | |||
https://designthinking.ideo.com/resources | https://designthinking.ideo.com/resources | ||
=== Design Canvas === | === Design Canvas === | ||
| Line 31: | Line 41: | ||
== Final Report == | == Final Report == | ||
=== Final Design Report === | === Final Design Report === | ||
=== Leadership in Energy and Environmental Design (LEED) Report === | === Leadership in Energy and Environmental Design (LEED) Report === | ||
== Why Is Keeping a Notebook Important? == | == Why Is Keeping a Notebook Important? == | ||
As engineers, a record of your work must be shown clearly to your employers and supervisors. As a student working on a long-term engineering project, you are expected to do the same. A notebook will be a valuable source of reference when developing a presentation for Recitation, understanding any changes a teammate may have made while working by themselves, or to return to a previous point should a new development fail to come to fruition. | As engineers, a record of your work must be shown clearly to your employers and supervisors. As a student working on a long-term engineering project, you are expected to do the same. A notebook will be a valuable source of reference when developing a presentation for Recitation, understanding any changes a teammate may have made while working by themselves, or to return to a previous point should a new development fail to come to fruition. | ||
Revision as of 19:56, 12 July 2022
Engineering Notebook
As you are working on your semester-long design project, it is critical that you maintain a record of your work and progress. In order to help create your Milestones and Final Presentation, as well as maintain your project schedule, the notebook should be updated regularly.
In order to pass a project Benchmark assessment, or to complete your final Submission, your notebook must be fully updated and deemed satisfactory by a TA. For Milestone 2, Milestone 3, and Final Submission you must have it approved by an Open Lab TA in a Word Document (DOC or DOCX) format. One engineering notebook needs to be maintained for a group.
Google Drive Folder Setup
At the beginning of each semester, each semester long design project (SLDP) team will create a Google Drive folder for documenting all of the work on their project. The folder will be shared with the recitation professor, recitation TA, RAD mentor (if applicable), and the lab TAs. The link to this folder must be uploaded to the EG Website submission page for SLDP Folders by the due date of the Milestone 1 presentation. This folder will contain a Google Doc for your engineering notebook and all other files used for your SLDP including but not limited to presentations, CAD files, code, circuit diagrams, pictures, budget spreadsheets, Microsoft Project schedule files, Preliminary Design Investigation, and Final Design Report. The engineering notebook should be used as documentation and an outline for the Milestone presentations, final presentation, and Final Design Report.
Notebook Guide
Engineering notebooks allow engineers to track and document their efforts. In turn, engineering notebooks can be used to assess each team member's contributions to the project and who owns the intellectual property. Engineering notebook should be updated weekly, and kept organized and legible for sharing with the team.
The engineering notebook include:
- Preliminary Design Investigation
- Meeting Notes
- Tracking of items for which you are responsible
- Deadlines and tasks for you and the team
- Technical Notes
- Designs, sketches, software code, and any other artifacts created for the VIP team
- Screenshots or pictures of your design
- Include the artifact itself, or where to find it (e.g., URL to repository)
- Record and briefly describe important resources (websites, books, people)
- Your ideas, brainstorming, questions, and general thoughts (even if not developed)
- Updates to cost or project schedule
- Plans for the future and to-do lists
The format of the EG 1004 Project Notebook is a Google Doc with chronological entries
Milestone assignments
The following assignments will be completed during recitation on the days of the milestone presentations. A picture or scan of the documents below should be included in your engineering notebook.
Design Thinking
IDEO is an organization that aims to supports designers with methods and strategies for critically thinking about the design process. https://designthinking.ideo.com/resources
Design Canvas
Design Pitch
https://www.darpa.mil/work-with-us/heilmeier-catechism
Final Report
Final Design Report
Leadership in Energy and Environmental Design (LEED) Report
Why Is Keeping a Notebook Important?
As engineers, a record of your work must be shown clearly to your employers and supervisors. As a student working on a long-term engineering project, you are expected to do the same. A notebook will be a valuable source of reference when developing a presentation for Recitation, understanding any changes a teammate may have made while working by themselves, or to return to a previous point should a new development fail to come to fruition.