Documentation Development - Revision history

YK at 19:09, 27 September 2012

2012-09-27T19:09:54Z

← Older revision		Revision as of 19:09, 27 September 2012
Line 54:		Line 54:

	Collaborative editing is also important to consider. Coordinating conflict-free revisions to a documentation package is the objective.		Collaborative editing is also important to consider. Coordinating conflict-free revisions to a documentation package is the objective.

			=Latest Documentation System=

			Use of Mediawiki to allow collaboratively edited set of webpages. Directly accessible information on the wikipages- mainly introductory data.

			Uploading downloadable new and revised project documentation packages for one-person project development.

			..... for multi-person project development.

	=Examples=		=Examples=

	http://opensourceecology.org/wiki/Terminal_Case		http://opensourceecology.org/wiki/Terminal_Case

YK at 19:05, 27 September 2012

2012-09-27T19:05:09Z

← Older revision		Revision as of 19:05, 27 September 2012
Line 50:		Line 50:

	An important feature for editing would be to connect the webpage contents and file link such that edits to the webpage contents automatically change the contents of the compressed package, and vice-versa.		An important feature for editing would be to connect the webpage contents and file link such that edits to the webpage contents automatically change the contents of the compressed package, and vice-versa.

			----

			Collaborative editing is also important to consider. Coordinating conflict-free revisions to a documentation package is the objective.

	=Examples=		=Examples=

	http://opensourceecology.org/wiki/Terminal_Case		http://opensourceecology.org/wiki/Terminal_Case

YK: /* Analysis */

2012-09-17T07:44:49Z

Analysis

← Older revision		Revision as of 07:44, 17 September 2012
Line 49:		Line 49:
	The integrated solution would involve being able to show the contents of the compressed file package directly on the webpage itself, with a download link to get a copy of the project info in a compressed file package.		The integrated solution would involve being able to show the contents of the compressed file package directly on the webpage itself, with a download link to get a copy of the project info in a compressed file package.

	~~The next level~~ would be to connect the webpage contents and file link such that edits to the webpage contents automatically change the contents of the compressed package.		An important feature for editing would be to connect the webpage contents and file link such that edits to the webpage contents automatically change the contents of the compressed package, and vice-versa.

	=Examples=		=Examples=

	http://opensourceecology.org/wiki/Terminal_Case		http://opensourceecology.org/wiki/Terminal_Case

YK: /* Analysis */

2012-09-17T07:44:04Z

Analysis

← Older revision		Revision as of 07:44, 17 September 2012
Line 41:		Line 41:
	'''Edit''': All files are editable as long as the file-format compatible software is accessible.		'''Edit''': All files are editable as long as the file-format compatible software is accessible.

	The major problem with compressed file packages is that they must be downloaded via link from a webpage, which means that the user cannot navigate and use the content directly from the webpage, and instead must pass through another step that takes time and decreases accessibility~~. The solution to this is high data transfer rate such that the file package can be downloaded quickly~~. Additionally, a user interested in a particular part of information still needs to download the entire package, which would be inefficient telecommunication.		The major problem with compressed file packages is that they must be downloaded via link from a webpage, which means that the user cannot navigate and use the content directly from the webpage, and instead must pass through another step that takes time and decreases accessibility. Additionally, a user interested in a particular part of information still needs to download the entire package, which would be inefficient telecommunication. The solution to this is high data transfer rate such that the file package can be downloaded quickly.

	----		----

YK: /* Analysis */

2012-09-17T07:43:40Z

Analysis

← Older revision		Revision as of 07:43, 17 September 2012
Line 41:		Line 41:
	'''Edit''': All files are editable as long as the file-format compatible software is accessible.		'''Edit''': All files are editable as long as the file-format compatible software is accessible.

	The major problem with compressed file packages is that they must be downloaded via link from a webpage, which means that the user cannot navigate and use the content directly from the webpage, and instead must pass through another step that takes time and decreases accessibility. The solution to this is high data transfer rate such that the file package can be downloaded quickly.		The major problem with compressed file packages is that they must be downloaded via link from a webpage, which means that the user cannot navigate and use the content directly from the webpage, and instead must pass through another step that takes time and decreases accessibility. The solution to this is high data transfer rate such that the file package can be downloaded quickly. Additionally, a user interested in a particular part of information still needs to download the entire package, which would be inefficient telecommunication.

	----		----

YK: /* Analysis */

2012-09-17T07:40:26Z

Analysis

← Older revision		Revision as of 07:40, 17 September 2012
Line 48:		Line 48:

	The integrated solution would involve being able to show the contents of the compressed file package directly on the webpage itself, with a download link to get a copy of the project info in a compressed file package.		The integrated solution would involve being able to show the contents of the compressed file package directly on the webpage itself, with a download link to get a copy of the project info in a compressed file package.

			The next level would be to connect the webpage contents and file link such that edits to the webpage contents automatically change the contents of the compressed package.

	=Examples=		=Examples=

	http://opensourceecology.org/wiki/Terminal_Case		http://opensourceecology.org/wiki/Terminal_Case

YK: /* Analysis */

2012-09-17T07:33:53Z

Analysis

← Older revision		Revision as of 07:33, 17 September 2012
Line 19:		Line 19:
	'''Accessibility''': A web browser is the major requirement.		'''Accessibility''': A web browser is the major requirement.

	'''Navigate''': ~~A table of contents acts as an index.~~		'''Navigate''': The webpage's 2D view and audio itself is the interface for navigation

	'''Copy''': Text and images can be copied. The webpage information can be downloaded as an html file.		'''Copy''': Text and images can be copied. The webpage information can be downloaded as an html file.
Line 45:		Line 45:
	----		----

	An integrated solution would be to design software that could provide the direct accessibility of a webpage's contents with the direct editability of a compressed file packages.		An integrated solution would be to design software that could provide the direct accessibility/navigability of a webpage's contents with the direct copyability/editability of a compressed file packages.

			The integrated solution would involve being able to show the contents of the compressed file package directly on the webpage itself, with a download link to get a copy of the project info in a compressed file package.

	=Examples=		=Examples=

	http://opensourceecology.org/wiki/Terminal_Case		http://opensourceecology.org/wiki/Terminal_Case

YK: /* Analysis */

2012-09-17T07:29:49Z

Analysis

@@ Line 24: / Line 24: @@
 '''Edit''': With wiki software, a set of webpages can be made editable.
 =Examples=
 http://opensourceecology.org/wiki/Terminal_Case

YK at 06:45, 17 September 2012

2012-09-17T06:45:36Z

← Older revision		Revision as of 06:45, 17 September 2012
Line 24:		Line 24:

	'''Edit''': With wiki software, a set of webpages can be made editable.		'''Edit''': With wiki software, a set of webpages can be made editable.

			=Examples=

			http://opensourceecology.org/wiki/Terminal_Case

YK: /* Open Source Documentation Objectives */

2012-09-17T05:42:14Z

Open Source Documentation Objectives

← Older revision		Revision as of 05:42, 17 September 2012
Line 8:		Line 8:

	*How easily can the user edit the original or copied information to revise the documentation?		*How easily can the user edit the original or copied information to revise the documentation?

			*How easily can edited information be made compatible with a different documentation system?

	=Analysis=		=Analysis=