Assembling Your Project 2 Portfolio: Technical Documentation

1. What is "Technical Documentation"?

In industry, a finished project isn't just the CAD file; it's the entire collection of documents that defines, validates, and explains the design. This package is often called a "Technical Product Documentation (TPD)" set or a "Design History File."

To get a formal understanding of the different documents involved in a professional engineering workflow, let's watch a brief overview.

Throughout this course, you've been systematically creating these very documents. For Project 2, your technical documentation package should include:

• Design Requirements: The initial document defining the project's goals.
• Concept Sketches & Decision Matrix: Shows your design process and rationale.
• 3D CAD Files: The complete Onshape assembly.
• Analysis Reports: Your bearing life calculations, shaft deflection analysis, and housing FEA results.
• Risk Assessment: The FMEA table you developed.
• Engineering Drawing Package: The detailed part and assembly drawings with GD&T.
• Final Bill of Materials (BOM): The complete list of parts and components.
• Design Review Presentation: The summary you created in the last lesson.

Now, the question is: how do you present this comprehensive package to a potential employer? You don't just send a zip file with 20 different documents. You need to curate it into a compelling story.

2. Structuring Your Portfolio Entry

A portfolio entry is a concise, visual summary of a project. It serves as the "cover story" for your detailed technical documentation. Your presentation from the last lesson is a great start, and now we'll refine it into a format specifically for a written portfolio.

The key is to tell a story using the "What, How, Results" framework. Let's review the essentials of creating a strong portfolio page.

To complement this, let's look at a more detailed guide on structuring the content and visuals.

Based on these resources, here's how to structure your Project 2 portfolio entry, which will likely be 1-2 pages in a PDF document:

1. Project Title: "Rotary Indexing Mechanism Design"
2. The Objective (The "What"): A 2-3 sentence summary of the project goal. What problem were you solving? (e.g., "Designed a compact rotary mechanism to provide precise 90-degree indexing for an automated assembly task.")
3. Visuals (The "Hero Shots"): The main focus of the page. Include 3-5 high-quality images:
   • A photorealistic rendering of the final assembly.
   • An exploded view showing how the components fit together.
   • A key analysis plot (like your housing FEA stress plot) with annotations.
   • A snippet of your final assembly drawing.
4. The Process (The "How"): Use concise bullet points to explain your engineering process. This is where you show your skills.
   • Concept: "Evaluated three transmission concepts (e.g., Geneva drive, worm gear, bevel gear) using a decision matrix to select the optimal solution based on cost, complexity, and precision."
   • Design: "Modeled the complete assembly in Onshape, including a custom housing and sourced components like gears, bearings, and fasteners."
   • Analysis: "Validated the design by performing shaft deflection and bearing life calculations. Verified housing integrity using FEA, achieving a minimum Factor of Safety of 4.2 under peak load."
   • Risk & DFM: "Conducted an FMEA to identify and mitigate key failure modes. Applied DFMA principles by designing the housing for 3-axis CNC machining and standardizing fasteners."
5. The Results (The Outcome): A clear statement of the project's success.
   • "The final design successfully meets all requirements for torque transmission and indexing accuracy within the specified size constraints."
   • "A complete technical documentation package, including drawings and analysis reports, was created to support manufacturing."

Here is an example of what a well-composed portfolio page can look like, blending different types of visuals to tell a story.

3. A Critical Consideration: Protecting Confidential Information

Since your goal is to simulate professional work, it's vital to understand how to handle proprietary information. While this is a personal project, practicing good habits now is essential. In a real job, you can't just post internal project details online.

4. Your Task: Compile the Project 2 Portfolio Entry

It's time to put theory into practice. Your task is to create the portfolio entry for your Rotary Mechanism project.

Part 1: Organize Your Documentation (5-10 minutes)

• On your computer, create a main folder named Project_2_Rotary_Mechanism.
• Inside this folder, create sub-folders to neatly organize all the deliverables you've created:
  • CAD (You can place a link to the Onshape document in a text file here)
  • Drawings (Save your drawing package PDF here)
  • Analysis (Save your calculation summaries and FEA reports here)
  • Project_Management (Save your requirements, FMEA, and BOM here)
  • Presentation (Save your design review presentation here)

Part 2: Create Your Portfolio Page(s) (25-30 minutes)

• Using a tool like Google Slides, PowerPoint, or Canva, create a 1- or 2-page document for your portfolio entry.
• Follow the structure outlined in Section 2: Title, Objective, Visuals, Process (How), and Results.
• Gather your best visuals: Export high-resolution images from Onshape (renderings, exploded views) and take clean screenshots of your analysis results and drawings. Remember the advice from the MIT guide: visuals should take up ~70% of the space!
• Write concise, powerful descriptions using strong action verbs (e.g., designed, analyzed, validated, optimized).
• Once you are satisfied, export the final document as a high-quality PDF. This PDF is your official portfolio entry for Project 2.

This finished PDF is a tangible asset that showcases not just your design skills, but your ability to see a project through from concept to final documentation.

Conclusion

Congratulations! You have now compiled all the necessary components of your second major project into a single, professional portfolio entry. This process of curating and presenting your work is a critical skill that separates a good engineer from a great communicator.

Key Takeaways:

• A professional portfolio entry is a curated story, not a raw data dump of all your files.
• Structure your project narrative around the "What, How, Results" framework to be clear and impactful.
• Lead with strong visuals (renderings, FEA plots, drawings) as they are the primary communication tool.
• Always be mindful of confidentiality, even on personal projects, as it's a critical professional habit.
• Maintaining an organized folder structure for each project makes compiling your portfolio much easier.

Preview of the Next Lesson:
With the full project documented, our final step for Project 2 is to write a technical summary for the rotary mechanism project. This is the short, text-based description you would use on your resume or LinkedIn profile to entice someone to view your full portfolio.