Documentation Standards - Revision history

Eric: Minor Text Formatting Fix

2023-09-27T00:16:27Z

Minor Text Formatting Fix

← Older revision		Revision as of 00:16, 27 September 2023
Line 228:		Line 228:
	*[[Open Source Hardware Documentation Jam]]		*[[Open Source Hardware Documentation Jam]]

	[[Category:Documentation]] [[Category: Open Source Standards]] [[Category:Standards]]		[[Category: Documentation]] [[Category: Open Source Standards]] [[Category: Standards]]

Eric: Added a Category to the Page

2023-09-27T00:16:12Z

Added a Category to the Page

← Older revision		Revision as of 00:16, 27 September 2023
Line 227:		Line 227:
	=Links=		=Links=
	*[[Open Source Hardware Documentation Jam]]		*[[Open Source Hardware Documentation Jam]]
	[[Category:Documentation]]
	[[Category:Standards]]		[[Category:Documentation]] [[Category: Open Source Standards]] [[Category:Standards]]

Alexau: /* Post Oct 2018 Intro */

2018-10-24T21:43:07Z

Post Oct 2018 Intro

← Older revision		Revision as of 21:43, 24 October 2018
Line 3:		Line 3:
	These documentation standards are so detailed and comprehensive that they become difficult to digest for the documenters who do the work. Here is an intermediary documentation process for how to prioritize different parts of these documentation standards so that contributors actually document things with the energy they have.		These documentation standards are so detailed and comprehensive that they become difficult to digest for the documenters who do the work. Here is an intermediary documentation process for how to prioritize different parts of these documentation standards so that contributors actually document things with the energy they have.

	Please see [[Documentation Standards: ~~Abbreviated~~]].		Please see [[P:Documentation Standards::Iterative Documentation Flow]].

	== Pre Oct 2018 Intro ==		== Pre Oct 2018 Intro ==

Alexau at 19:07, 12 October 2018

2018-10-12T19:07:22Z

← Older revision		Revision as of 19:07, 12 October 2018
Line 1:		Line 1:
	=Introduction=		=Introduction=
			== Post Oct 2018 Intro ==
			These documentation standards are so detailed and comprehensive that they become difficult to digest for the documenters who do the work. Here is an intermediary documentation process for how to prioritize different parts of these documentation standards so that contributors actually document things with the energy they have.

			Please see [[Documentation Standards: Abbreviated]].

			== Pre Oct 2018 Intro ==
	In Dan Benamy's opinion, this page is confusing and needs some cleanup, focusing, clarifying, and/or splitting up. Normally he do that work but it looks like Marcin set up this page and he doesn't want to get in Marcin's way. Dan will just add a link here to [[How to Structure the Wiki for GVCS Machines]] which he'd normally integrate into the page if he understood it :-)		In Dan Benamy's opinion, this page is confusing and needs some cleanup, focusing, clarifying, and/or splitting up. Normally he do that work but it looks like Marcin set up this page and he doesn't want to get in Marcin's way. Dan will just add a link here to [[How to Structure the Wiki for GVCS Machines]] which he'd normally integrate into the page if he understood it :-)

Marcin: /* Open Source Hardware Project Listings */

2018-06-27T20:47:16Z

Open Source Hardware Project Listings

← Older revision		Revision as of 20:47, 27 June 2018
Line 219:		Line 219:
	*[[Open Source Hardware Projects]]		*[[Open Source Hardware Projects]]

			=Links=
			*[[Open Source Hardware Documentation Jam]]
	[[Category:Documentation]]		[[Category:Documentation]]
	[[Category:Standards]]		[[Category:Standards]]

Daniel Benamy at 11:54, 14 January 2014

2014-01-14T11:54:51Z

← Older revision		Revision as of 11:54, 14 January 2014
Line 1:		Line 1:
	=Introduction=		=Introduction=
			In Dan Benamy's opinion, this page is confusing and needs some cleanup, focusing, clarifying, and/or splitting up. Normally he do that work but it looks like Marcin set up this page and he doesn't want to get in Marcin's way. Dan will just add a link here to [[How to Structure the Wiki for GVCS Machines]] which he'd normally integrate into the page if he understood it :-)

	As OSE moves towards viral replicability, it is important to create effective documentation standards. This applies to the work of OSE and also towards creating a broader platform for open source product development. To this end, we are studying existing open source industry standards - to pick out existing best practice and to integrate these into a larger platform. The strategy is to remix as many existing tools as possible - while inspiring the related players to contribute to a greater platform.		As OSE moves towards viral replicability, it is important to create effective documentation standards. This applies to the work of OSE and also towards creating a broader platform for open source product development. To this end, we are studying existing open source industry standards - to pick out existing best practice and to integrate these into a larger platform. The strategy is to remix as many existing tools as possible - while inspiring the related players to contribute to a greater platform.

Doogtoog: Removed qwiki reference.

2013-04-04T01:58:07Z

Removed qwiki reference.

← Older revision		Revision as of 01:58, 4 April 2013
Line 191:		Line 191:
	*Make Projects - http://makeprojects.com/		*Make Projects - http://makeprojects.com/
	*OKFN [http://design.okfn.org/about/ Open Design Definition]		*OKFN [http://design.okfn.org/about/ Open Design Definition]
	*Qwiki - see example of [http://www.qwiki.com/q/Induction_heating induction furnace].
	*[[IKEA Furniture Documentation Standards]]		*[[IKEA Furniture Documentation Standards]]
	*Check out Army Manuals standards for documentation. What other best practice manuals are there? Check the [[Noun Project]].		*Check out Army Manuals standards for documentation. What other best practice manuals are there? Check the [[Noun Project]].

Marcin: /* Basic Wiki Version */

2013-03-30T21:44:50Z

Basic Wiki Version

← Older revision		Revision as of 21:44, 30 March 2013
Line 45:		Line 45:

	=Basic Wiki Version=		=Basic Wiki Version=
			Non-Structured OSHW Documentation:

	<html><img src="https://docs.google.com/drawings/d/1wp2VnMd-JYoVDWeiMz-eXDrT-1p7kZUW0eq8BupIYZw/pub?w=543&h=362"></html>		<html><img src="https://docs.google.com/drawings/d/1wp2VnMd-JYoVDWeiMz-eXDrT-1p7kZUW0eq8BupIYZw/pub?w=543&h=362"></html>

Marcin: /* User Stories */

2013-02-09T16:06:08Z

User Stories

← Older revision		Revision as of 16:06, 9 February 2013
Line 26:		Line 26:
	*As a builder, I want to access the build instructions, videos, and BOMs for a successful build.		*As a builder, I want to access the build instructions, videos, and BOMs for a successful build.
	*As a replicator, I want to assess the state of completion of the product. I also want to disambiguate between product that does not exist vs. documentation that does not exist. Ie, some Product might be built, but documentation may not exist - so absence of documentation does not necessarily mean absence of product.		*As a replicator, I want to assess the state of completion of the product. I also want to disambiguate between product that does not exist vs. documentation that does not exist. Ie, some Product might be built, but documentation may not exist - so absence of documentation does not necessarily mean absence of product.
			*As an open source economist, I need to see the economic analysis to see scaling potential of a manufacturing enterprise for a machine.

	==Developer==		==Developer==
Line 31:		Line 32:
	*As a developer working on a further iteration, I need a place to update the documentation without messing up the structure and integrity of prior documenation, because some changes of content also affects other parts of the documentation.		*As a developer working on a further iteration, I need a place to update the documentation without messing up the structure and integrity of prior documenation, because some changes of content also affects other parts of the documentation.
	*As a minor developer who made only a small improvement, I need to make sure that my work is documented.		*As a minor developer who made only a small improvement, I need to make sure that my work is documented.
	*As a publisher, I want to publish a machine manual readily.
	*As a builder, I want to access the build instructions, videos, and BOMs for a successful build.
	*As a reviewer, I want to see a history of how the machine versions have evolved over time, and I want to see performance calculations to verify them.		*As a reviewer, I want to see a history of how the machine versions have evolved over time, and I want to see performance calculations to verify them.
	*As an open source economist, I need to see the economic analysis to see scaling potential of a manufacturing enterprise for a machine.
	*As an information architect, I need to know how the documentation modules fit together.		*As an information architect, I need to know how the documentation modules fit together.
	*As a database designer, I need access to a taxonomy of all the content, and I need a sample of all the modules to test my display methods.		*As a database designer, I need access to a taxonomy of all the content, and I need a sample of all the modules to test my display methods.
			==Publisher==
			*As a publisher, I want to publish a machine manual readily.

			==Video Editor==

	*As a video editor making instructionals, I need access to videos of various builds the results, and issues encountered during builds.		*As a video editor making instructionals, I need access to videos of various builds the results, and issues encountered during builds.
	*As an eye-candy video editor, I need footage of sparks flying during production, as well as other flashy footage.		*As an eye-candy video editor, I need footage of sparks flying during production, as well as other flashy footage.

Marcin: /* Replicator */

2013-02-09T16:03:25Z

Replicator

← Older revision		Revision as of 16:03, 9 February 2013
Line 25:		Line 25:
	==Replicator==		==Replicator==
	*As a builder, I want to access the build instructions, videos, and BOMs for a successful build.		*As a builder, I want to access the build instructions, videos, and BOMs for a successful build.
			*As a replicator, I want to assess the state of completion of the product. I also want to disambiguate between product that does not exist vs. documentation that does not exist. Ie, some Product might be built, but documentation may not exist - so absence of documentation does not necessarily mean absence of product.

	==Developer==		==Developer==
	*As a developer, I need a place to upload content, and I need a clear structure so that I know where to upload it.		*As a developer, I need a place to upload content, and I need a clear structure so that I know where to upload it.