Engineering Documentation

Study Guide

Prepare to document engineering work clearly enough that another person can understand, evaluate, and continue your design process.

Go to Practice Check Certification Home

1. Purpose of engineering documentation

Documentation records what was designed, tested, changed, and learned.
Good documentation helps a team communicate, defend decisions, repeat tests, and improve designs.
Documentation is evidence, not decoration.
A strong record lets someone else understand the work without relying only on memory.
Incomplete documentation makes it difficult to troubleshoot, grade, revise, or manufacture a design.

2. Engineering notebook entries

Each entry should include the date, title, project/task, and purpose.
Entries should be written in chronological order whenever possible.
Use complete enough notes that the work can be understood later.
Sketches, tables, calculations, and photos should be labeled.
Do not erase or hide mistakes; explain changes and lessons learned.

3. Design decisions and rationale

Record the options considered before choosing a design direction.
Explain why a decision was made using constraints, criteria, evidence, or test results.
Decision matrices should include criteria, weights when used, scores, and a short interpretation.
Do not simply write “we picked this because it was best.” Explain what made it best.
Good rationale connects the decision to the problem requirements.

4. Data and testing records

Record what was tested, how it was tested, and what variables were controlled or changed.
Use tables for measurements, trials, observations, and calculated results.
Include units on all measured values.
Record failures and unexpected results honestly.
Summarize what the data means and how it affects the next design decision.

5. Visual evidence

Photos and screenshots should show useful evidence, not just final glamour shots.
Label images with what they show and why they matter.
Use captions for prototype photos, test setups, CAD screenshots, and fabrication steps.
Include scale references or measurements when size matters.
Show failures and revisions, not only successful final designs.

6. Revisions and engineering changes

Track what changed, when it changed, and why it changed.
Use revision notes for CAD files, drawings, prototypes, and major design decisions.
A revision should describe the problem or opportunity that caused the change.
Keep old versions when they provide useful comparison or evidence.
Change records help teams avoid repeating old mistakes.

7. File naming and organization

Use consistent, descriptive file names that include project, part, version, or date when helpful.
Avoid names like “final,” “final2,” or “new new final” without version context.
Keep related CAD files, images, data sheets, and presentations organized by project.
Make sure linked files and shared documents are accessible to the right team members.
Use version control habits even when working with simple class files.

8. Final deliverables

Final documentation should connect the problem, constraints, design process, testing, revisions, and final outcome.
Use headings, bullets, tables, and images to make information easy to follow.
Claims should be supported by evidence from sketches, tests, calculations, or observations.
Presentation slides should summarize the design story, not replace the full notebook record.
Strong documentation shows both product quality and process quality.

Hands-on performance checklist

To earn the badge, students must submit or show documentation that includes purpose, design reasoning, evidence, test data or observations, revision notes, and readable organization.

Take Practice Check Go to Final Test