Mark J Norton/GVCS Template
Proposed GVCS Product Template
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
- User Manual
- 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
The Overview Page is intended to be starting page of the GVCS project description. It should contain high level information about the project, what problems its solves, descriptions of features, rationales, etc. It includes a detailed project status that is summarized in the GVCS Tools Status.
- 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)
- Link to Index Page
Research
The research section (pages) captures background theory, conceptual background, links to similar projects and other work. Anything information that informs the design and supports development should be included in these pages.
- 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