Difference between revisions of "Engineering Notebook"

From EG1004 Lab Manual
Jump to: navigation, search
 
(41 intermediate revisions by 4 users not shown)
Line 1: Line 1:
<!--== Google Drive Folder Setup ==
= Documentation Requirements =
== Preliminary Design Investigation ==
== Notebook Guide ==
== Milestone assignments ==
=== Design Thinking ===
=== Design Canvas ===
=== Design Pitch ===


== Final Report ==
Maintaining a documentation of your progress is an important part of the engineering design process. It can help you see how your project evolves over its duration, provide a space for you and your teammates track work done asynchronously or separately, and even be evidence of intellectual property.
=== Final Design Report ===
=== Leadership in Energy and Environmental Design (LEED) Report ===-->


= Engineering Notebook =
In this class, you will practice these organizational and reflective skills by maintaining a Google Drive folder that contains all of your project files, a group engineering notebook, and a project schedule. Our section instructors will check your documentation for completion throughout the semester, particularly at Benchmarks.


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.  
== Google Drive Folder Setup ==
At the beginning of the semester, we will create a Google Drive folder for your team to document all of the work on their project. This folder will be shared with your section instructors. Once the link is shared with you, please add the link to this folder the EG Website Submission section in the '''Professional Development''' tab by the due date of the Milestone 1 presentation. This folder will contain a Google Doc for your engineering notebook, your project schedule, and all other files used for your SLDP. It is your space for collaboration.


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.
== Engineering Notebook Guide ==
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 our portfolio, the final presentation, the final report, tracking changes throughout the semester, or attributing credit to who was responsible for contributions to the project. If you wish to continue development of your ideas your engineering notebook can be used to claim ownership of the intellectual property developed during the project.


== Why Is Keeping a Notebook Important? ==
Please refer to our [https://docs.google.com/document/d/1EjWGjL15smyJlBE5KPcy8gZBSfFj288iQ1hBljNB5aw/edit?usp=sharing template] and a [https://docs.google.com/document/d/1CbGggtBuyi1DG7kbm3XYVYMZycQFCoh7ErpqiPVkyIE/edit?usp=sharing checklist] for what you should include. Our instructors will refer to this checklist at Benchmarks and can refer to this document at any point during the semester.
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.  


== What is a Fully Satisfactory Notebook? ==
At Milestones, you will also complete in-class assignments that should be completed in your engineering notebooks designed for you to reflect on your design thinking processes:


In order to qualify for Benchmarking, your notebook must meet the following criteria:
* [[Media:EG_1004_Design_Thinking_Workbook.pdf|Exercise 1: Defining a Design Challenge (IDEO, 2012).]]
* Minimum of two entries per week on your project status. If you did not work on it that week, or only worked on it once, provide explanation on why (e.g. ahead of schedule, already Benchmarked, preoccupied with other work, etc).
* Professional formatting. Your notebook should be more than a list of bullet points.
* All topics discussed below in What Should You Include In Your Notebook?
* Clear insight on which teammate is logging the notebook, as well as who is responsible for what tasks that have been completed.


== What Should You Include In Your Notebook? ==
* [[Media:EG_1004_Engineering_Design_Canvas.pdf|Exercise 2: Creating a Engineering Design Canvas (Kline et al., 2017)]].


There is no specific format directly required of you. You are free to format your Engineering Notebook however you deem most appropriate. However, keep in mind that many TAs, Professors, and Writing Consultants may reference your notebook at any time to view the status of your group.
* [[Media:EG_1004_Design_Pitch.pdf|Exercise 3: Pitching a Design (Heilmeier, 2022).]]


* Your notebook should be ordered chronologically including but not limited to the following information:
= References =
# Topics discussed at a meeting together
IDEO. (2012). Toolkit – Design Thinking for Educators. https://page.ideo.com/design-thinking-edu-toolkit
## Major developments on how the group wants to proceed
 
## Division of labor
Kline, W., Schindel, W., Tranquillo, J., Bernal, A., & Hixson, C. (2017). Development of a design canvas with application to first-year and capstone design courses. https://peer.asee.org/development-of-a-design-canvas-with-application-to-first-year-and-capstone-design-courses
## Individual accomplishments
 
# Developments in code
G.H.Heilmeier, “The Heilmeier Catechism” [Online], Available: https://www.darpa.mil/work-with-us/heilmeier-catechism
## Screenshots
## Plans for the future
# Developments for a physical model (not applicable to virtual semesters)
## Pictures of the model
# Plans for Recitation presentations
# Updates to cost or project schedule

Latest revision as of 04:49, 1 July 2025

Documentation Requirements

Maintaining a documentation of your progress is an important part of the engineering design process. It can help you see how your project evolves over its duration, provide a space for you and your teammates track work done asynchronously or separately, and even be evidence of intellectual property.

In this class, you will practice these organizational and reflective skills by maintaining a Google Drive folder that contains all of your project files, a group engineering notebook, and a project schedule. Our section instructors will check your documentation for completion throughout the semester, particularly at Benchmarks.

Google Drive Folder Setup

At the beginning of the semester, we will create a Google Drive folder for your team to document all of the work on their project. This folder will be shared with your section instructors. Once the link is shared with you, please add the link to this folder the EG Website Submission section in the Professional Development tab by the due date of the Milestone 1 presentation. This folder will contain a Google Doc for your engineering notebook, your project schedule, and all other files used for your SLDP. It is your space for collaboration.

Engineering Notebook Guide

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 our portfolio, the final presentation, the final report, tracking changes throughout the semester, or attributing credit to who was responsible for contributions to the project. If you wish to continue development of your ideas your engineering notebook can be used to claim ownership of the intellectual property developed during the project.

Please refer to our template and a checklist for what you should include. Our instructors will refer to this checklist at Benchmarks and can refer to this document at any point during the semester.

At Milestones, you will also complete in-class assignments that should be completed in your engineering notebooks designed for you to reflect on your design thinking processes:

References

IDEO. (2012). Toolkit – Design Thinking for Educators. https://page.ideo.com/design-thinking-edu-toolkit

Kline, W., Schindel, W., Tranquillo, J., Bernal, A., & Hixson, C. (2017). Development of a design canvas with application to first-year and capstone design courses. https://peer.asee.org/development-of-a-design-canvas-with-application-to-first-year-and-capstone-design-courses

G.H.Heilmeier, “The Heilmeier Catechism” [Online], Available: https://www.darpa.mil/work-with-us/heilmeier-catechism

Retrieved from "https://manual.eg1004.courses/index.php?title=Engineering_Notebook&oldid=15805"