Skip to content

Hardware Documentation

Connor Novak edited this page Apr 28, 2018 · 2 revisions

Introduction

Documentation isn't just for code anymore, now MechEs can use it too! The goal of hardware documentation is for later researchers to be able to use your documentation to duplicate your component/assembly or make a better version based on the lessons you learned throughout your process. To document these intangibles, it is helpful to break mechanical documentation up into design intent, fabrication process, and bill of materials.

Design Intent

Documentation of a component's design intent should ideally be a paragraph detailing the 'why' of the part. If you are making an assembly of multiple parts, write a design intent paragraph for each part (within reason, design intent for a bolt is unnecessary). The design intent paragraph should describe two things: the component's function and how it's design helps it perform the function. This paragraph should also document any hard problems you encountered while designing the component. Someone looking to remake/improve the part should be able to read your documentation and understand why you made your design choices.

Fabrication Process

Fabrication process documentation is important for later analysis of speed/ease of manufacturing and stress/strain information. A brief description of the main steps you went through and the tools you used (with comments if you feel a better tool would have been more appropriate) should be satisfactory. Someone looking to remake/improve the part should be able to use your fabrication process as an instruction manual.

Bill of Materials

A bill of materials (BOM) serves the dual purposes of being both a list of components and an overall pricing chart. Your BOM should list each part you bought and each raw material you purchased along with prices, quantities, and location/website purchased or obtained. Someone looking to remake/improve the part should be able to use your BOM as a shopping list. For professional BOM advice, see the Helpful Links section.

Helpful Links

  • Arena Solutions: Creating a Bill of Materials (link)
  • Proto2Prod: Creating and Optimizing a Bill of Materials (link)

Table of Contents

Tutorials

Thrusts

  • Overview - Overview of Thrust Work
  • GRAVL - Ground Robotic Autonomous Vehicle Lab
  • HIRo - Human Interactions Robotics Laboratory
  • ORCAS - Olin Robotic Collaborative Autonomous Submersibles
  • Baymax- Eusocial Robotics
  • MORA - Miniature Oscillating Robot Agent (robofish swarms!)

General Documentation

Clone this wiki locally