Product Template - Revision history

Syk0 saje: templates category already under standards

2011-05-04T10:18:39Z

templates category already under standards

← Older revision		Revision as of 10:18, 4 May 2011
Line 47:		Line 47:
	[[Image:tractorblue.png\|right\|100px]]*'''ToolNameicon.jpg''' - icons from Isaiah on blue background like the one to the right. Entire set will be put up at the [[Product Ecologies]] page. Make sure to upload icons as files with names of the format "ToolNameicon.jpg". It won't work if you name it something else, like "ToolName Icon.jpg", "Icon for ToolName.jpg" etc.		[[Image:tractorblue.png\|right\|100px]]*'''ToolNameicon.jpg''' - icons from Isaiah on blue background like the one to the right. Entire set will be put up at the [[Product Ecologies]] page. Make sure to upload icons as files with names of the format "ToolNameicon.jpg". It won't work if you name it something else, like "ToolName Icon.jpg", "Icon for ToolName.jpg" etc.

			[[Category: Templates]]
	~~[[Category:Standards]]~~[[Category:Templates]]

Isaiahsaxon: added "why it works" under the user manual template as recommended by Saul Griffith

2011-05-03T06:58:29Z

added "why it works" under the user manual template as recommended by Saul Griffith

← Older revision		Revision as of 06:58, 3 May 2011
Line 37:		Line 37:
	**Calculations (for scaling purposes)		**Calculations (for scaling purposes)
	*'''ToolName user's manual'''.		*'''ToolName user's manual'''.
			**Why it works (the physics)
	**Operation Procedures		**Operation Procedures
	**Safety		**Safety

Conor: minor formatting change

2011-03-23T02:30:55Z

minor formatting change

← Older revision		Revision as of 02:30, 23 March 2011
Line 44:		Line 44:
	*'''ToolName Bill of Materials'''. Weblinks to suggested sources. Prices.		*'''ToolName Bill of Materials'''. Weblinks to suggested sources. Prices.
	*'''Buy ToolName'''. This will raise funds for OSE. We can sell both kits and finished devices. This should be used only for tools with [[Full Product Release]] status.		*'''Buy ToolName'''. This will raise funds for OSE. We can sell both kits and finished devices. This should be used only for tools with [[Full Product Release]] status.
	*'''ToolNameicon.jpg''' - icons from Isaiah on blue background ~~such as [[Image:tractorblue.png\|100px]]~~. Entire set will be put up at the [[Product Ecologies]] page. Make sure to upload icons as files with names of the format "ToolNameicon.jpg". It won't work if you name it something else, like "ToolName Icon.jpg", "Icon for ToolName.jpg" etc.		[[Image:tractorblue.png\|right\|100px]]*'''ToolNameicon.jpg''' - icons from Isaiah on blue background like the one to the right. Entire set will be put up at the [[Product Ecologies]] page. Make sure to upload icons as files with names of the format "ToolNameicon.jpg". It won't work if you name it something else, like "ToolName Icon.jpg", "Icon for ToolName.jpg" etc.


	[[Category:Standards]][[Category:Templates]]		[[Category:Standards]][[Category:Templates]]

Conor: Attempt at complete instructions for documenting tools - please improve!

2011-03-20T23:19:25Z

Attempt at complete instructions for documenting tools - please improve!

← Older revision		Revision as of 23:19, 20 March 2011
Line 5:		Line 5:
	This can be used for any of the tools; just insert the name of the tool in place of 'CEB Press' and the software will generate the rest of it based on [[Template:ToolTemplate\|this]].		This can be used for any of the tools; just insert the name of the tool in place of 'CEB Press' and the software will generate the rest of it based on [[Template:ToolTemplate\|this]].

	This template generates links the following pages. ~~We will have to gather~~ the ~~information~~ on ~~each tool~~ under the following standard page titles:		This template generates links to the following pages. All information on the tools should be put on the wiki under the following standard page titles:

	~~Bold links~~ to:		*'''ToolName Intro'''. This should assume the reader has no prior knowledge and explain -
			#What the machine does. The very first sentence of the Intro page should be a one sentence description of the machine in plain English. e.g. "The Liberator is a machine that makes building blocks out of soil", "RepRap is a 3D printer; it can make plastic objects of any chosen shape."
			##Problem Statement. Explain the advantages of this sort of technology. Why did we want to build it? What issue the tool is aiming to address e.g. "building a low-cost, high performance CEB press at $3k in materials, where the competition charges $45k for the finished product, to increase access to this environmentally-friendly, low-cost, and high performance building method"
			#Design Rationale
			##Give a simplified description of how it works. This should usually include a conceptual diagram and/or a conceptual video. (A more detailed description will be given in the Build Instructions, but if the reader gets an entry-level description here, it will be easier to understand the more detailed description later.)
			##explain design choices that were made based on [[OSE Specifications]]
			#Video and/or photos of the machine in action, plus other interesting footage directly from the project
			#Product Ecology - how the tool fits with the other tools of the GVCS; see [[Product Ecologies]]
			#Specifications, displayed alongside specifications for a similar commercial machine
			#Costs, displayed alongside costs for a similar commercial machine. Include maintenance and running costs where applicable

	*'''ToolName Development'''. ~~See~~ [[GVCS Development Template]]		*'''ToolName Development'''. We need to figure out a system of version control. Possibly a graphic indicating prototype number, a chart or number showing the stage of the [[GVCS Development Template]]. Maybe display this as a progress bar [http://labs.nortd.com/images/lasersaur-progress.png like the Lasersaur open development site]. When a tool is in an development stage, this page should be updated frequently and kept up-to-date.
	**When a tool is in an development stage, this page should be updated frequently and kept up-to-date
	***progress report		***progress report
	***list of unanswered questions		***list of unanswered questions
	***current tasks		***current tasks
	*'''ToolName Build Instructions'''. ~~See [[~~Instructional ~~Page Template]]~~		**funding situation
	*~~'''ToolName user's manual'''. See [[User Manual Page Template]]~~		**expected date of completion
			*'''ToolName Build Instructions'''.
			**Instructional Video (A to Z on the fabrication)
	~~Followed by:~~		**Instructional text and photos (A to Z on the fabrication). This is the same information as in the video, but some people might prefer step-by-step photos (for example, in developing countries where they don't have the bandwidth to stream video)
			**Augmented Reality instructional material - this is not a necessity, but it is the next generation level of documentation which would allow for rapid teaching of fabrication
	*~~'''ToolName Intro'''~~. ~~Can include problem statement, design rationale, maybe a video or photos showing~~ the ~~machine~~ in ~~action. It should familiarize newcomers with~~ the ~~machine's abilities. We can include a comparison to existing commercial models here too.~~ (It'~~s impossible to~~ have ~~a separate page for each of these, because it would make~~ the ~~navigation box way too noisy.~~)		**3D model and CAD file
	*~~Product Icon - icons from Isaiah on blue background such as [[Image:tractorblue.png\|100px]]. Entire set will be put up at the [[Product Ecologies]] page~~		**2D fabrication drawings (metal)
	*~~Status Headline~~ - ~~graphic indicating prototype number~~, ~~step~~ of ~~completion from the [[Product Development Template]], funding, expected date~~ of ~~completion. Status Chart~~ (~~references development template~~)~~, and refers to [[Master Index]] for overview~~		**2d Exploded Part Diagram
	*~~Problem Statement~~ - ~~what issue the development of the GVCS tool is aiming~~ to ~~address - such as ''building a low-cost~~, ~~high performance CEB press at $3k in materials, where the competition charges $45k~~ for ~~the finished product, as a means to increasing access to this environmentally-friendly, low-cost, and high performance building method''~~		**Machine-readable CAM files
	*~~Performance Analysis vs. Industry Standards~~ (~~data viz~~) ~~- list our specifications compared to those of off-shelf counterparts~~		**Circuit design file to build circuit boards, wiring diagram
	*~~Cost Analysis vs~~. ~~Industry Standards~~		**Computer Software Control Code for Automated Devices
	*~~Conceptual Diagram - how does the tool work? Entry-level explanation using quality information architecture~~		**Hydraulic Circuit Diagram
	*~~Design Rationale - key design features that explain design choices related that were made based on [[OSE Specifications]]~~		**Calculations (for scaling purposes)
	*~~Product Ecology - how the tool fits with the other tools of the GVCS; see [[Product Ecologies]]~~		*'''ToolName user's manual'''.
	*~~Demo Video - video documentation taken from the actual build or testing of the device, plus other interesting footage directly from the project~~		**Operation Procedures
	*~~Demo Photos~~		**Safety
	*'''ToolName Bill of Materials'''.		**Maintenance
			**Repair
			**Troubleshooting
			*'''ToolName Bill of Materials'''. Weblinks to suggested sources. Prices.
	*'''Buy ToolName'''. This will raise funds for OSE. We can sell both kits and finished devices. This should be used only for tools with [[Full Product Release]] status.		*'''Buy ToolName'''. This will raise funds for OSE. We can sell both kits and finished devices. This should be used only for tools with [[Full Product Release]] status.
			*'''ToolNameicon.jpg''' - icons from Isaiah on blue background such as [[Image:tractorblue.png\|100px]]. Entire set will be put up at the [[Product Ecologies]] page. Make sure to upload icons as files with names of the format "ToolNameicon.jpg". It won't work if you name it something else, like "ToolName Icon.jpg", "Icon for ToolName.jpg" etc.


	[[Category:Standards]][[Category:Templates]]		[[Category:Standards]][[Category:Templates]]

Conor at 22:30, 20 March 2011

2011-03-20T22:30:17Z

← Older revision		Revision as of 22:30, 20 March 2011
Line 10:		Line 10:

	*'''ToolName Development'''. See [[GVCS Development Template]]		*'''ToolName Development'''. See [[GVCS Development Template]]
			**When a tool is in an development stage, this page should be updated frequently and kept up-to-date
			***progress report
			***list of unanswered questions
			***current tasks
	*'''ToolName Build Instructions'''. See [[Instructional Page Template]]		*'''ToolName Build Instructions'''. See [[Instructional Page Template]]
	*'''ToolName user's manual'''. See [[User Manual Page Template]]		*'''ToolName user's manual'''. See [[User Manual Page Template]]

Marcin at 21:28, 19 February 2011

2011-02-19T21:28:39Z

← Older revision		Revision as of 21:28, 19 February 2011
Line 16:		Line 16:
	Followed by:		Followed by:

			*'''ToolName Intro'''. Can include problem statement, design rationale, maybe a video or photos showing the machine in action. It should familiarize newcomers with the machine's abilities. We can include a comparison to existing commercial models here too. (It's impossible to have a separate page for each of these, because it would make the navigation box way too noisy.)
	*Product Icon - icons from Isaiah on blue background such as [[Image:tractorblue.png\|100px]]. Entire set will be put up at the [[Product Ecologies]] page		*Product Icon - icons from Isaiah on blue background such as [[Image:tractorblue.png\|100px]]. Entire set will be put up at the [[Product Ecologies]] page
	*Status Headline, Problem Statement, Performance Analysis vs. Industry Standards (data viz), Cost Analysis vs. Industry Standards, Conceptual Diagram~~, Product Ecology, Demo Video, Demo Photos,~~ Design Rationale~~, Status Chart (references development template)~~		*Status Headline - graphic indicating prototype number, step of completion from the [[Product Development Template]], funding, expected date of completion. Status Chart (references development template), and refers to [[Master Index]] for overview
			*Problem Statement - what issue the development of the GVCS tool is aiming to address - such as ''building a low-cost, high performance CEB press at $3k in materials, where the competition charges $45k for the finished product, as a means to increasing access to this environmentally-friendly, low-cost, and high performance building method''
	*~~'''ToolName Intro'''. Can include problem statement, design rationale, maybe a~~ video or ~~photos showing~~ the machine in action. It should familiarize newcomers with the machine's abilities. We can include a comparison to existing commercial models here too. (It's impossible to have a separate page for each of these, ~~because it would make~~ the ~~navigation box way too noisy.)~~		*Performance Analysis vs. Industry Standards (data viz) - list our specifications compared to those of off-shelf counterparts
			*Cost Analysis vs. Industry Standards
			*Conceptual Diagram - how does the tool work? Entry-level explanation using quality information architecture
			*Design Rationale - key design features that explain design choices related that were made based on [[OSE Specifications]]
			*Product Ecology - how the tool fits with the other tools of the GVCS; see [[Product Ecologies]]
			*Demo Video - video documentation taken from the actual build or testing of the device, plus other interesting footage directly from the project
			*Demo Photos
	*'''ToolName Bill of Materials'''.		*'''ToolName Bill of Materials'''.
			*'''Buy ToolName'''. This will raise funds for OSE. We can sell both kits and finished devices. This should be used only for tools with [[Full Product Release]] status.
	*'''Buy ToolName'''. This will raise funds for OSE. We can sell both kits and finished devices.



	[[Category:Standards]][[Category:Templates]]		[[Category:Standards]][[Category:Templates]]

Marcin at 21:17, 19 February 2011

2011-02-19T21:17:06Z

← Older revision		Revision as of 21:17, 19 February 2011
Line 16:		Line 16:
	Followed by:		Followed by:

	*Product Icon - icons from Isaiah on blue background such as [[Image:tractorblue.png\|100px]]		*Product Icon - icons from Isaiah on blue background such as [[Image:tractorblue.png\|100px]]. Entire set will be put up at the [[Product Ecologies]] page
	*Status Headline, Problem Statement, Performance Analysis vs. Industry Standards (data viz), Cost Analysis vs. Industry Standards, Conceptual Diagram, Product Ecology, Demo Video, Demo Photos, Design Rationale, Status Chart (references development template)		*Status Headline, Problem Statement, Performance Analysis vs. Industry Standards (data viz), Cost Analysis vs. Industry Standards, Conceptual Diagram, Product Ecology, Demo Video, Demo Photos, Design Rationale, Status Chart (references development template)

Marcin at 21:16, 19 February 2011

2011-02-19T21:16:18Z

← Older revision		Revision as of 21:16, 19 February 2011
Line 16:		Line 16:
	Followed by:		Followed by:

	*Product Icon - icons from Isaiah on blue background such as [[Image:tractorblue.~~jpg~~\|100px]]		*Product Icon - icons from Isaiah on blue background such as [[Image:tractorblue.png\|100px]]
	*Status Headline, Problem Statement, Performance Analysis vs. Industry Standards (data viz), Cost Analysis vs. Industry Standards, Conceptual Diagram, Product Ecology, Demo Video, Demo Photos, Design Rationale, Status Chart (references development template)		*Status Headline, Problem Statement, Performance Analysis vs. Industry Standards (data viz), Cost Analysis vs. Industry Standards, Conceptual Diagram, Product Ecology, Demo Video, Demo Photos, Design Rationale, Status Chart (references development template)

Marcin at 21:15, 19 February 2011

2011-02-19T21:15:34Z

← Older revision		Revision as of 21:15, 19 February 2011
Line 6:		Line 6:

	This template generates links the following pages. We will have to gather the information on each tool under the following standard page titles:		This template generates links the following pages. We will have to gather the information on each tool under the following standard page titles:
	*'''ToolName Intro'''. Can include problem statement, design rationale, maybe a video or photos showing the machine in action. It should familiarize newcomers with the machine's abilities. We can include a comparison to ~~existing commercial models here too. (It's impossible to have a separate page for each of these, because it would make the navigation box way too noisy.)~~
			Bold links to:

	*'''ToolName Development'''. See [[GVCS Development Template]]		*'''ToolName Development'''. See [[GVCS Development Template]]
	*'''ToolName Bill of Materials'''.
	*'''ToolName Build Instructions'''. See [[Instructional Page Template]]		*'''ToolName Build Instructions'''. See [[Instructional Page Template]]
	*'''Buy ToolName'''. This will raise funds for OSE. We can sell both kits and finished devices.
	*'''ToolName user's manual'''. See [[User Manual Page Template]]		*'''ToolName user's manual'''. See [[User Manual Page Template]]


			Followed by:

	~~=Other Information=~~		*Product Icon - icons from Isaiah on blue background such as [[Image:tractorblue.jpg\|100px]]
	~~Machine Page Template:~~ (~~one~~ page for ~~every machine~~)		*Status Headline, Problem Statement, Performance Analysis vs. Industry Standards (data viz), Cost Analysis vs. Industry Standards, Conceptual Diagram, Product Ecology, Demo Video, Demo Photos, Design Rationale, Status Chart (references development template)

			*'''ToolName Intro'''. Can include problem statement, design rationale, maybe a video or photos showing the machine in action. It should familiarize newcomers with the machine's abilities. We can include a comparison to existing commercial models here too. (It's impossible to have a separate page for each of these, because it would make the navigation box way too noisy.)

			*'''ToolName Bill of Materials'''.

			*'''Buy ToolName'''. This will raise funds for OSE. We can sell both kits and finished devices.

	~~Bold links to:~~
	~~Development Page~~
	~~Instructional Page~~
	~~User Manual Page~~

	~~Followed by:~~
	Product Icon, Status Headline, Problem Statement, Performance Analysis vs. Industry Standards (data viz), Cost Analysis vs. Industry Standards, Conceptual Diagram, Product Ecology, Demo Video, Demo Photos, Design Rationale, Status Chart (references development template)

	[[Category:Standards]][[Category:Templates]]		[[Category:Standards]][[Category:Templates]]

Marcin at 21:12, 19 February 2011

2011-02-19T21:12:10Z

← Older revision		Revision as of 21:12, 19 February 2011
Line 15:		Line 15:


			=Other Information=
			Machine Page Template: (one page for every machine)

			Bold links to:
			Development Page
			Instructional Page
			User Manual Page

			Followed by:
			Product Icon, Status Headline, Problem Statement, Performance Analysis vs. Industry Standards (data viz), Cost Analysis vs. Industry Standards, Conceptual Diagram, Product Ecology, Demo Video, Demo Photos, Design Rationale, Status Chart (references development template)

	[[Category:Standards]][[Category:Templates]]		[[Category:Standards]][[Category:Templates]]