OSHW-OSE-CNC_Torch_Table-v2

	A	B	C
1	Taxonomy Item	Guidelines	Substance
2	See annotated taxonomy - http://opensourceecology.org/wiki/OSHW_Documentation_Taxonomy
3	Device Dashboard
4	Name	Clearly state the hardware's name, avoid confusion with other similar projects and infrigements of trademarks.	OSE CNC Torch Table
5	Description	Textual description of the hardware. Include link to Google Translate.	Modular (4"x4" square tubing frame), scalable (from 4x4 feet to 6x any length) CNC Torch table with 1/64" precision and sufficient rigidity to hold a CNC Router equivalent to a ShopBot (75lb linear force)
6	Hardware Version	State the hardware's version in a highly visible place. Optional: indicate date of release. Ex: V4 - Dec 18, 2012	v2 - away from 1"x1" gantry of v1 to a cold-rolled rails with 3x gear-down rack and pinion drive
7	Software Version	State the software's version in a highly visible place. Optional: indicate date of release. Ex: V4 - Dec 18, 2012	v2 - Arduino toolchain as in RepRap - away from LinuxCNC of v1
8	Hardware License	State the hardware's open source license and link to license page. Ex: CC BY-SA	cc-by-sa
9	Software License	State the software's open source license and link to license page. Ex: GPL	GPL
10	Attribution	Identify the authors and contributors. Identify Active Team Members. Optional: state how you'd like the authors to be credited.	OSE Team, Ben Horton, Marcin Jakubowski
11	Open Source Label	Graphic indicating which layers of the design are open source. Place in very prominant area (eg. product's home page). Ex: Electronics: open; Mechanics: closed; Software: closed; Hydraulics: open.; Materials: closed (ex., for special steel alloy)	open hardware, open software, open firmware, open source controller, closed source stepper motors
12	Graphical Representation	Provide hi-res images of the hardware, preferably allowing zooming and 3D rotation. Use a real picture or a computer model.	http://opensourceecology.org/wiki/File:Table_Frame.JPG
13	Status Brief	State the level of completion of the Hardware, active problem that is currently being solved, and future development intentions. Describe known issues. Burndown graph would be useful. Ex: Hardware: complete; Software: complete; Documentation: incomplete; Enterprise: product shipping, open business model. Next steps: robustness improvements to allow for 100 hours of unattended operation.	http://opensourceecology.org/wiki/OSHW-OSE-CNC_Torch_Table-Status_Brief
14	Change Log	List of changes/upgrades since last version of the design.	Upgrading to robust gantry system with 3x torque, for about 75 lb of pushing force for router duty; head interchangeability for CNC router and 100 W Laser Cutter
15	Specifications	List the hardware's specifications. Ex: http://www.ladyada.net/make/tvbgone/	1G acceleration in torch duty 75 lb linear force in router duty Interchangeable heads, including hot wire cutter 4'x4' base working area scalable to 6'x infinity Open Source stepper motor controller
16	Compatibility	State what other peices of hardware the design is compatible with. Ex: Arduino Leonardo	StepperNug open source stepper motor controller, Arduidon, LifeTrac Constructon Set 4x4" tubing frame option; open source rotary encoder for eventual drive with Open Source Servo Motor
17	Dependency	State what other types of hardware or software are necessary to use the hardware during normal operation, during building, during assembly, during testing, and during de-assembly. Ex: 5V Power Supply, Ethernet Shield	CNC Torch table for frame and gantry cutting; CNC Multimachine for gear and rack drive, plus eventually stepper motor controller fabrication
18	Geneology	Provide information on the hardware's origins, derivatives and replications. Copy this from the previous version and include your new version.	see Ti
19	Human Factors & Usability Overview	State general considerations for user-friendliness and performance, such as: (1), whether a machine is 'turnkey,' or whether one has to make numerous adjustments prior to use. Time/procedure required prior to turn-on. (2) Comfort and extras - ex. a cushioned driver's seat that is indispensible for long-time use; lights for night-time use; air-tight cab for a car in cold winter, etc. (3) Unattended operation vs. necessity to watch the machine or make constant adjustements; (4) Quality of result obtained - while Specifications (above) provide quantitative assessment, a quick overview of qualitative performance is useful to assess value of replicating the machine, such as: rough edges are left after a cut with the machine; 'the machine is unbearably so', or 'the machine works equivalent to or better than any commercial counterpart based on speed and quality of resulting product.'
20	Related Projects	List related projects. If done properly, this has the potential to spawn collaboration between similar projects. Ex: Local Motors, Wikispeed for OS Car project.
21	Related Resources	List related resources such as other tutorials, similar projects, wikipedia pages, etc.
22	Tags	List tags that best decsribe the device/design. Make sure to include OSHW. Ex: OSHW-Shield-Arduino-Electronics.
23	Replication Map	Show locations of all machines in use to keep track of the evolution of the project.
24	Communication Channels	List media of communication, such as Website, Blogs, Wikis, Databases, Support Platform, Google Groups, Facebook Groups, Twitter feed, hashtag, forums, Stack Overflow, email addresses, chats, texting, phone numbers, and other venues of development. Optionally, include notes on how to communicate effectively.
25	Explainer Video	Produce a scripted animation or video showing how the artifact works, why it is important, and otherwise motivate users to engage with the artifact. Show context for how this artifact fits with a greater ecosystem of OSHW. Make this video 2 minutes or under.
26	Repository	Link to repositories of project files. (git, hg, etc.)
27	Build Dashboard
28	Difficulty Level	State the difficulty level for building the device. Ex: Intro Level, Intermediate, Advanced
29	Time Required	State the approximate time required to build the device. Ex: 2 days.
30	Tools Required	List the tools needed to build the device. Ex: laser cutter, welder, soldering iron.
31	Space Required	Indicate the space required to build the device. Ex: 1000 sf workshop
32	Skills Required	Indicate what skills are required to build the device. Ex: welding, laser cutting.
33	Cost	Include a budget for the project and state the total cost of materials and components.
34	Safety & Health	Warnings on any dangers or risks associated with the build of the artifact - such as risk of injury from moving parts, heavy objects, potential accidents, chemical dangers, fumes, etc..
35	Ergonomics	State the expected time for the build of the artifact. Provide suggestions on effective build process to minimize effort and maximize comfort of the builder. Do this analysis for different production routes used - such as by hand vs. by utilizing automation.
36	Materials & Components
37	Bill of Materials (BOM)	BOM's and all parts lists should include unique identifiers: item name, item description, quantity, dimensions/package, suppliers* part number, link to datasheet, image, price, notes. (*required fields) Provide information on alternative materials and components whenever possible. Ex: if carbon fiber is not available use punched aluminum. Prefer listing hardware project names based on their semantic versioning name so that they can be automatically found and re-used by software.
38	Designs
39	Conceptual Design	Conceptual design is the type of design that describes general working principles and outlines main components of an artifact, without necessarily providing dimensionally-correct design of the artifact. Show all the critical parts.
40	Conceptual Interface Design	Show a diagram of an interface prior to that interface being built.
41	Labeled Diagram	This is the actual labeled design - a step above the Concept Design. The labeled diagram may be a CAD or real picture, and it should include different angles. Diagram should label components.
42	Digital Fabrication Files	Provide digital fabrication files for download in at least one but preferably more standard formats. Provide previews of digital fabrication files.
43	Module Diagram	Shows the breakdown of the Artifact into modules. Does not have to show components of modules - as the Labeled Diagram already contains this.
44	Exploded View Drawing	http://en.wikipedia.org/wiki/Exploded_view_drawing . Use 3D or isometric drawings as appropriate.
45	3D CAD	Provide 3D CAD of the object, and applies to all 3-dimensional artifacts. Use a commonly accessible platform such as Sketchup in preference to less accessible, proprietary software. Include tolerance information, as discussed at http://opensourceecology.org/wiki/Geometric_Dimensioning_and_Tolerancing
46	3D preview	Provide a preview of all parts in 3D.
47	3D Scan	If CAD is not available, provide a 3D scan of an artifact.
48	Engineering Drawings	Engineering drawings are technical drawings used to fully describe the requirements of engineered items. For machines, this is fabrication drawings.
49	Fabrication Drawings	A special type of engineering drawing used for mechanical devices.
50	2D Preview	Embed the complete design files for a preview of the design.
51	Wiring, Cable Routing, Hose Routing Diagram	Layout of flexible or stiff conduits of all sorts (wires, hoses, airlines, etc) should be provided.
52	Electronics	Provide hi-res electronics schematics (symbolic representation of the circuit, showing how to connect the components). Provide PCB layout (concrete representation of the circuit, used to fabricate PCBs). Provide preview of schematics. Ex: http://arduino.cc/en/Main/arduinoBoardDuemilanove
53	Process Design	Produce a design of a process, such as chemical processing. Include all steps, retention times, substances used, etc. Document toolchain in a flowchart.
54	Hydraulics & Pneumatics	Provide a diagram of hydraulic design. Use standard hydraulic symbols, as in http://opensourceecology.org/wiki/Hydraulic_Circuit_Design
55	Electromagnetic Diagram	Provide field lines involved in magnetic devices.
56	Optical Diagrams	Provide optical diagrams - such as ray tracing or focal lengths - for optical systems.
57	Design Rationale	Explanation of why certain design decisions were made for the artifact. Document why you chose one design over another, with reference to Analysis of Industry Standards
58	Calculations	Calculations are required to understand the performance of a machine. These could be power, thermal, force, stress, hydraulics, flow, speed, structural, electromagnetic, or other calculations. This includes Computer Aided Engineering (CAE) analysis such as Finite Element Analysis (FEA). Document any derived quantities. Document online calculator/design resources.
59	Physics of Why It Works	Explanation of first principles involved in the functioning of the machine.
60	Logic Design	Document operating step sequencing and any other logic model required for the operation of the artifact.
61	Animated Model	Animation showing functional mechanism.
62	Design Review	Document reviews of a design. Design review can be general or specific.
63	Failure Modes and Effects Analysis	Analize a design prior to the build for possible failures and document this analysis, including solutions.
64	3D Diffs	Show the difference between versions of the artifact in 3D representation.
65	Software
66	Source Code	Provide annotated source code, including code logic. Ex., describe brick pressing logic based on physical structure and function of CEB machine.
67	Firmware	Provide firmware.
68	Instructions	Provide instructions for running, installing, compiling, etc.
69	Libraries	Provide any libraries or links to libraries that are needed
70	Build Instructions
71	Infrastructure Requirements	List the space, power, tooling, timing, environment, and other requirements for the build to occur.
72	Tool List	List tools used in production of Artifact.
73	Jig Design	Show designs of any jigs used in production, and document procedures for using these jigs.
74	Machine Settings	Describe fabrication/production procedures, including suggested machine settings (ex: laser cutter settings, mixing time for cement mixer)
75	Assembly	Provide set-by-step instructions on how to assemble the Product (from raw materials, parts and/or modules) using either: - Clear, hi-res images accompanied by clear textual instructions (include link to Google Translate). - IKEA-style visual instructions
76	Assembly Video	Produce a video of artifact assembly and disassembly.
77	Procedure	Provide step-by-step sequence of instructions on how to make Products. This could be a process (for materials), fabrication procedure (for components), procedure (for building) using: - Clear, hi-res images accompanied by clear textual instructions (include link to Google Translate).- IKEA-style visual instructions - others.
78	Instructional Video	Provide step-by-step video documentation.
79	Quality Control	Procedure for testing the artifact build throughout the fabrication process. Define, execute, and document this procedure.
80	Integration Checklist	List cosiderations that have to be taken when putting all modules together.
81	Testing
82	Rapid Prototyping	Make scale models of artifacts with a laser cutter and 3D printer to test out parts fit and other issues. Document the build instructions and results of prototype builds.
83	Test Design	Design and document a testing procedure and protocol for a finished design.
84	Data Collection	Collect performance data on the artifact. Discuss how the data was obtained.
85	Safety Issues	Make careful observations about any safety concerns of using the artifact, and document these.
86	Known Bugs	Make an exhaustive list of any known issues about the artifact.
87	Destructive Testing	Test the artifact to its failure limit and gather performance data until that point. Discuss the point of failure.
88	Product Certification	Provide official test data and certification from professional standards associations.
89	User Manual
90	Operation	Startup, operating, calibration instructions.
91	Safety	Safety instructions.
92	Maintenance	Describe standard procedures for maintenance over time.
93	Troubleshooting	Discuss common failure modes and state how these can be identified and fixed.
94	Repair	Document common problems and procedures for fixing them.
95	Product Hacking	Document how to modify artifact or how to use it with other modules. Provide insights on user experience.
96	Specific Use Cases	Document techniques of how to apply the artifact to specific tasks. Ex., discuss the procedure for using the torch table to cut a brick press out of metal sheet.
97	Build Techniques	Provide tutorials on fabrication processes required to build, repair, or modify the artifact, in more detail than in the fabrication process.
98	Sourcing	Document part sources, availability, cost.
99	Enterprise
100	Economic Analysis	Evaluate production cost, including facility, consumables, materials, labor. Calcultate return on investment.