Mark J Norton/GVCS Template: Difference between revisions

From Open Source Ecology
Jump to navigation Jump to search
No edit summary
Line 6: Line 6:
The template consists of the following sections:
The template consists of the following sections:


* Overview
# Overview
* Research
# Research
* Design
# Design
* Development
# Development
* Specifications
# Specifications
* Bill of Materials
# Bill of Materials
* Build Instructions
# Build Instructions
* User Manual
# User Manual
* How to Buy (optional)
# How to Buy (optional)


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.
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.

Revision as of 23:18, 30 June 2011

Proposed GVCS Product Template

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

The template consists of the following sections:

  1. Overview
  2. Research
  3. Design
  4. Development
  5. Specifications
  6. Bill of Materials
  7. Build Instructions
  8. User Manual
  9. How to Buy (optional)

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
    • Speed
    • Throughput
    • Weight
    • Size Constraints
    • Feed stocks
  • 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
    • Parts to be Purchased with Alternatives
    • Parts to be Fabricated
    • Weight of Parts and Total Weight
  • 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)

User Manual

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

How to Buy

This section could be eliminated as it has no bearing on the development process.

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