Wiki Templates: Difference between revisions

From Open Source Ecology
Jump to navigation Jump to search
Line 29: Line 29:
=Instructional Page Template=
=Instructional Page Template=


Design Rationale, Conceptual Diagram, Bill of Materials (with weblinks to sources), Demo Video, Demo Photos, Instructional Video (A to Z on the fabrication), 3d CAD file (metal fabrication), 2d fabrication drawings (metal), 2d electronics design file to build circuit boards, wiring diagram, Machine-readable CAM files, 2d Exploded Part Diagram, Computer Software Control Code for Automated Devices, Hydraulic Circuit Diagram, Calculations (for scaling purposes)
This should cover everything required to replicate a machine. May have some overlap with Product Page
 
*Design Rationale
*Conceptual Diagram
*Bill of Materials (with weblinks to sources)
*Demo Video (could include animation of CEB press from Blender, or real footage)
*Demo Photos
*Instructional Video (A to Z on the Fabrication)
*Functional/Block Diagram - explaining further details, if any, not covered in Conceptual Diagram; explanations of key mechanisms
*3d CAD file (metal fabrication), 2d fabrication drawings (metal), 2d electronics design file to build circuit boards, wiring diagram,  
*Machine-readable CAM files
*2d Exploded Part Diagram
*Computer Software Control Code for Automated Devices, or any other software
*Hydraulic Circuit Diagram, or any other supporting diagrams
*Calculations (for scaling purposes)


=User Manual Template=
=User Manual Template=

Revision as of 05:42, 30 March 2011

Outline of Wiki Templates

Page Title should be Machine Name, where official Names are found at http://opensourceecology.org/gvcs.php, and the icons are found in this GIMP file

Machine Page Template: (one page for every machine)

Bold links to:

  • Development Page
  • Instructional Page
  • User Manual Page

Followed by:

  • Product Icon - Isaiah's iconn
  • Status Headline - few words on where it is (such as completed, design completed, which prototype number, etc.)
  • Problem Statement - may be taken from Proposal 2012
  • Performance Analysis vs. Industry Standards (data viz)
  • Cost Analysis vs. Industry Standards
  • Conceptual Diagram - graphic of working concept
  • Product Ecology - show how it fits with other products of Product Ecologies
  • Demo Video
  • Demo Photos
  • Design Rationale - main decisions for instantiation and how they relate to OSE Specifications
  • Status Chart - infographic showing percent completed, funded, Step of GVCS_Development_Template (references development template)

Development Page Template

Then there is the GVCS_Development_Template for technical development.

Instructional Page Template

This should cover everything required to replicate a machine. May have some overlap with Product Page

  • Design Rationale
  • Conceptual Diagram
  • Bill of Materials (with weblinks to sources)
  • Demo Video (could include animation of CEB press from Blender, or real footage)
  • Demo Photos
  • Instructional Video (A to Z on the Fabrication)
  • Functional/Block Diagram - explaining further details, if any, not covered in Conceptual Diagram; explanations of key mechanisms
  • 3d CAD file (metal fabrication), 2d fabrication drawings (metal), 2d electronics design file to build circuit boards, wiring diagram,
  • Machine-readable CAM files
  • 2d Exploded Part Diagram
  • Computer Software Control Code for Automated Devices, or any other software
  • Hydraulic Circuit Diagram, or any other supporting diagrams
  • Calculations (for scaling purposes)

User Manual Template

(Why it Works? - physics), How it Works, Operation Procedures, Safety, Maintenance, Troubleshooting, Repair

Why it works = (to be inspired look at bicyclying science, david gordon wilson)

torque and power, gearing, transmission, center of gravity relationship to terrain, steering mechanisms (ackerman - why), terrain (mud vs hard ground, why / effect on power etc), efficiency (how to know and measure whether it is working as planned)