Mark J Norton/GVCS Template: Difference between revisions
No edit summary |
|||
| (13 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
=Proposed GVCS Product Template= | |||
'''Machine Page Template:''' (one page for every machine) Includes Icon | '''Machine Page Template:''' (one page for every machine) Includes Icon | ||
| Line 7: | Line 5: | ||
The template consists of the following sections: | The template consists of the following sections: | ||
# Overview | |||
# Research | |||
# Design | |||
# Specifications | |||
# Bill of Materials | |||
# Build Instructions | |||
# Development | |||
# 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. | 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= | =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? | * Problem Statement - What Problems does this Tool Solve? | ||
| Line 29: | Line 29: | ||
* Demo Video (once built) | * Demo Video (once built) | ||
* Product Pictures (once built) | * Product Pictures (once built) | ||
* Link to Index Page | |||
=Research= | =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 | * Theory | ||
| Line 38: | Line 41: | ||
=Design= | =Design= | ||
Design is the process of deciding what specifically shall be built. It is based on the current understanding of the requirements (documented here) and includes descriptive text, various drawings and diagrams, and an exploration of the trade-offs and choices among alternatives. | |||
* Requirements | * Requirements | ||
** Speed | |||
** Throughput | |||
** Weight | |||
** Size Constraints | |||
** Feed stocks | |||
* Design Description | |||
* Calculations - energy, efficiency | * Calculations - energy, efficiency | ||
* Drawings and Diagrams | * Drawings and Diagrams | ||
| Line 49: | Line 60: | ||
* Decisions and Alternative Choices | * Decisions and Alternative Choices | ||
= | =Specifications= | ||
Specifications include descriptions of all parts, elements, sub-assembles, etc. that make up the GVCS tool. It specifies what parts will be purchased, any modifications to purchased parts, and what parts will be fabricated. Actual fabrication is described in the Build Instructions later. | |||
* Descriptions of all Parts | * Descriptions of all Parts | ||
** Parts to be Purchased with Alternatives | |||
** Parts to be Fabricated | |||
** Weight of Parts and Total Weight | |||
* Dimensions of all Parts | * Dimensions of all Parts | ||
* Safety Considerations | * Safety Considerations | ||
| Line 70: | Line 73: | ||
=Bill of Materials= | =Bill of Materials= | ||
The bill of materials describes what parts to buy and what to fabricate. Sources of purchased parts is specified here. | |||
* List of Parts to Buy | * List of Parts to Buy | ||
| Line 76: | Line 81: | ||
=Build Instructions= | =Build Instructions= | ||
The build instructions explain in as much detail as is needed how to fabricate new parts, modify purchased parts, and how to make sub-assemblies, and the full product assembly. Instruction is documented in the form of textual instructions, 2D technical drawings, 3D CAD files, CAM and CRC files (if needed), software (if needed), etc. | |||
* Fabrication Drawings | * Fabrication Drawings | ||
| Line 90: | Line 97: | ||
* Hydraulic Circuit Diagrams (if needed) | * Hydraulic Circuit Diagrams (if needed) | ||
= | =Development= | ||
Development is the process of gathering resources and building prototypes. It includes a list of the project team and their roles, an overview of industry standards (where they exist), description of how development will be funded, and notes on experiments and prototype development. Ideally it should include an analysis of failure modes. Tests on the prototypes based on testing protocols are recorded. Development is NOT production. It is part of the overall process of creating a new GVCS product. | |||
* | * 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 | |||
=User Manual= | =User Manual= | ||
The user manual describes how to operate the GVCS tool, how to maintain it, what can go wrong, and how to fix it. | |||
* Overview of how it works, references to theory and research | * Overview of how it works, references to theory and research | ||
| Line 104: | Line 121: | ||
* Troubleshooting | * Troubleshooting | ||
* Repair | * 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 | |||
[[Category: Wiki]] | [[Category: Wiki]] | ||
[[Category: Standards]] | [[Category: Standards]] | ||
Latest revision as of 23:34, 30 June 2011
Proposed GVCS Product Template
Machine Page Template: (one page for every machine) Includes Icon
The template consists of the following sections:
- Overview
- Research
- Design
- Specifications
- Bill of Materials
- Build Instructions
- Development
- 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
Design is the process of deciding what specifically shall be built. It is based on the current understanding of the requirements (documented here) and includes descriptive text, various drawings and diagrams, and an exploration of the trade-offs and choices among alternatives.
- Requirements
- Speed
- Throughput
- Weight
- Size Constraints
- Feed stocks
- Design Description
- 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
Specifications
Specifications include descriptions of all parts, elements, sub-assembles, etc. that make up the GVCS tool. It specifies what parts will be purchased, any modifications to purchased parts, and what parts will be fabricated. Actual fabrication is described in the Build Instructions later.
- 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
The bill of materials describes what parts to buy and what to fabricate. Sources of purchased parts is specified here.
- List of Parts to Buy
- List of Parts to Fabricate
- Sources of Parts
Build Instructions
The build instructions explain in as much detail as is needed how to fabricate new parts, modify purchased parts, and how to make sub-assemblies, and the full product assembly. Instruction is documented in the form of textual instructions, 2D technical drawings, 3D CAD files, CAM and CRC files (if needed), software (if needed), etc.
- 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)
Development
Development is the process of gathering resources and building prototypes. It includes a list of the project team and their roles, an overview of industry standards (where they exist), description of how development will be funded, and notes on experiments and prototype development. Ideally it should include an analysis of failure modes. Tests on the prototypes based on testing protocols are recorded. Development is NOT production. It is part of the overall process of creating a new GVCS product.
- 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
User Manual
The user manual describes how to operate the GVCS tool, how to maintain it, what can go wrong, and how to fix it.
- 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