Mark J Norton/GVCS Template

12/11/10

Alternative Wiki Templates:

Machine Page Template: (one page for every machine) Includes Icon

The template consists of the following sections:

• Overview
• Research
• Design
• Development
• Specifications
• Bill of Materials
• Build Instructions
• How to Buy
• User Manual

Contents of these sections are defined in the following sections. Where a great deal of information exists on a sub-part, they can be broken out into sub-page(s) and linked appropriately.

Overview

• Problem Statement - What Problems does this Tool Solve?
• High Level Description
• Rational for this Tool
• Product Ecology - How it Relates to Other GVCS Tools
• Schedule - Milestones met, Future Goals
• Project Status
• Demo Video (once built)
• Product Pictures (once built)

Research

• Theory
• Interesting Links
• Relevant Work
• Conceptual Notes

Design

• Requirements
• Calculations - energy, efficiency
• Drawings and Diagrams
  • Concept and Alternatives
  • Full Design Views
  • Cut-away Views
  • Exploded Parts View
  • 3D Renders of the Product
• Decisions and Alternative Choices

Development

• Project Team and Roles
• Industry Standards
• Funding
• Peer Reviews
• Experiments and Prototypes
  • Experimental Results
  • Prototype Notes, Observations, etc.
• Failure Mode Analysis
• Testing Results
• Recommendations for Improvement

Specifications

• Descriptions of all Parts
• Dimensions of all Parts
• Safety Considerations
• Test Protocols

Bill of Materials

• List of Parts to Buy
• List of Parts to Fabricate
• Sources of Parts

Build Instructions

• Fabrication Drawings
• Fabrication Instructions
• Fabrication Videos
• Assembly Instructions
• Assembly Video
• 3D CAD files
• CAM and CRC files
• Software (if needed)
• 2D Circuit Board Layouts (if needed)
• Wiring Diagrams (if needed)
• Circuit Schematics (if needed)
• Hydraulic Circuit Diagrams (if needed)

How to Buy

• Who supplies it
• How much does it cost
• Product Variations (kit, assembled, etc.)
• Shipping Costs

User Manual

• Overview of how it works, references to theory and research
• Operation Procedures
• Maintenance
• Troubleshooting
• Repair