Documentation Strategy - Revision history

YK: /* Documentation Platform Summary */

2012-07-04T06:11:23Z

Documentation Platform Summary

← Older revision		Revision as of 06:11, 4 July 2012
Line 25:		Line 25:
	*Ease of syncing with project repositories (web-hosting and updating the contents of a project is necessary for others to access the project's files and documentation)		*Ease of syncing with project repositories (web-hosting and updating the contents of a project is necessary for others to access the project's files and documentation)

	We need to consider a stand-alone program that is executable from a locally pulled project repository. This stand-alone program should allow ease of local content navigation and understanding as well as ease of local editing. Downloading the repository to start with as well as syncing the local contents would then be considered as functions of another program more focused on file downloading and uploading. Perhaps all 4 ~~functiona;~~ modules into 1 software would be better streamlined.		We need to consider a stand-alone program that is executable from a locally pulled project repository. This stand-alone program should allow ease of local content navigation and understanding as well as ease of local editing. Downloading the repository to start with as well as syncing the local contents would then be considered as functions of another program more focused on file downloading and uploading. Perhaps all 4 functional modules into 1 software would be better streamlined.

	=Final Product Release Documentation Template for Book/PDF/eBook=		=Final Product Release Documentation Template for Book/PDF/eBook=

YK: /* Documentation Platform Summary */

2012-07-04T06:10:36Z

Documentation Platform Summary

← Older revision		Revision as of 06:10, 4 July 2012
Line 13:		Line 13:
	=Documentation Platform Summary=		=Documentation Platform Summary=

	Currently, we use a combination of the Wikimedia platform and Github.		Currently, we use a combination of the Wikimedia platform and Github. Consider how an effective documentation platform would integrate webpage content and locally stored content.

	We are looking for:		We are looking for:

	*Ease to download entire project contents to a local directory		*Ease to download entire project contents to a local directory (required for people to easily start their own projects based on existing project information)

	*Ease of navigating and understanding the local content		*Ease of navigating and understanding the local content (required for people to easily use project content that is downloaded to their local storage)

	*Ease of editing the local content		*Ease of editing the local content (fits into above, but involving editing)

	*Ease of syncing with project repositories		*Ease of syncing with project repositories (web-hosting and updating the contents of a project is necessary for others to access the project's files and documentation)

	We need to consider a stand-alone program that is executable from a locally pulled project repository. This stand-alone program should allow ease of local content navigation and understanding as well as ease of local editing. Downloading the repository to start with as well as syncing the local contents would then be considered as functions of another program more focused on file downloading and uploading. Perhaps all 4 functiona; modules into 1 software would be better streamlined.		We need to consider a stand-alone program that is executable from a locally pulled project repository. This stand-alone program should allow ease of local content navigation and understanding as well as ease of local editing. Downloading the repository to start with as well as syncing the local contents would then be considered as functions of another program more focused on file downloading and uploading. Perhaps all 4 functiona; modules into 1 software would be better streamlined.

YK: /* Documentation Platform Summary */

2012-07-04T06:03:32Z

Documentation Platform Summary

← Older revision		Revision as of 06:03, 4 July 2012
Line 19:		Line 19:
	*Ease to download entire project contents to a local directory		*Ease to download entire project contents to a local directory

	*Ease of navigating the local content		*Ease of navigating and understanding the local content

	*Ease of editing the local content		*Ease of editing the local content
Line 25:		Line 25:
	*Ease of syncing with project repositories		*Ease of syncing with project repositories

	We need to consider a stand-alone program that is executable from a locally pulled project repository. This stand-alone program should allow ease of local content navigation as well as ease of local editing. Downloading the repository to start with as well as syncing the local contents would then be considered as functions of another program more focused on file downloading and uploading. Perhaps all 4 functiona; modules into 1 software would be better streamlined.		We need to consider a stand-alone program that is executable from a locally pulled project repository. This stand-alone program should allow ease of local content navigation and understanding as well as ease of local editing. Downloading the repository to start with as well as syncing the local contents would then be considered as functions of another program more focused on file downloading and uploading. Perhaps all 4 functiona; modules into 1 software would be better streamlined.

	=Final Product Release Documentation Template for Book/PDF/eBook=		=Final Product Release Documentation Template for Book/PDF/eBook=

YK: /* Documentation Platform Summary */

2012-07-04T06:02:53Z

Documentation Platform Summary

← Older revision		Revision as of 06:02, 4 July 2012
Line 25:		Line 25:
	*Ease of syncing with project repositories		*Ease of syncing with project repositories

	We need to consider a stand-alone program that is executable from a locally pulled project repository. This stand-alone program should allow ease of local content navigation as well as ease of local editing. Downloading the repository to start with as well as syncing the local contents would then be considered as functions of another program more focused on file downloading and uploading.		We need to consider a stand-alone program that is executable from a locally pulled project repository. This stand-alone program should allow ease of local content navigation as well as ease of local editing. Downloading the repository to start with as well as syncing the local contents would then be considered as functions of another program more focused on file downloading and uploading. Perhaps all 4 functiona; modules into 1 software would be better streamlined.

	=Final Product Release Documentation Template for Book/PDF/eBook=		=Final Product Release Documentation Template for Book/PDF/eBook=

YK: /* Documentation Platform Summary */

2012-07-04T06:02:23Z

Documentation Platform Summary

← Older revision		Revision as of 06:02, 4 July 2012
Line 17:		Line 17:
	We are looking for:		We are looking for:

	*Ease ~~of editing existing content~~		*Ease to download entire project contents to a local directory

	*Ease of ~~pulling~~ content ~~to a local directory for rapid local analysis~~		*Ease of navigating the local content

	*Ease of ~~documentation and syncing with repositories~~		*Ease of editing the local content

	We need to consider a stand-alone program that is executable from a locally pulled project repository. This stand-alone program should allow ease of local content navigation as well as ease of local editing.		*Ease of syncing with project repositories

			We need to consider a stand-alone program that is executable from a locally pulled project repository. This stand-alone program should allow ease of local content navigation as well as ease of local editing. Downloading the repository to start with as well as syncing the local contents would then be considered as functions of another program more focused on file downloading and uploading.

	=Final Product Release Documentation Template for Book/PDF/eBook=		=Final Product Release Documentation Template for Book/PDF/eBook=

YK: /* Documentation Key Summary */

2012-07-04T05:58:59Z

Documentation Key Summary

← Older revision		Revision as of 05:58, 4 July 2012
Line 10:		Line 10:

	*Ease of Editing		*Ease of Editing

			=Documentation Platform Summary=

			Currently, we use a combination of the Wikimedia platform and Github.

			We are looking for:

			*Ease of editing existing content

			*Ease of pulling content to a local directory for rapid local analysis

			*Ease of documentation and syncing with repositories

			We need to consider a stand-alone program that is executable from a locally pulled project repository. This stand-alone program should allow ease of local content navigation as well as ease of local editing.

	=Final Product Release Documentation Template for Book/PDF/eBook=		=Final Product Release Documentation Template for Book/PDF/eBook=

YK at 05:39, 28 June 2012

2012-06-28T05:39:10Z

← Older revision		Revision as of 05:39, 28 June 2012
Line 1:		Line 1:
			=Documentation Key Summary=

			Documentation involves the transfer of information.

			The top open documentation priorities are:

			*Quality Content

			*Quick Navigation

			*Ease of Editing

	=Final Product Release Documentation Template for Book/PDF/eBook=		=Final Product Release Documentation Template for Book/PDF/eBook=

Aidan Williamson: /* Build It */

2012-06-28T02:46:34Z

Build It

← Older revision		Revision as of 02:46, 28 June 2012
Line 23:		Line 23:
	#*All materials needed		#*All materials needed
	#**Sourcing		#**Sourcing
			#*All proficiencies needed
			#**Links to Wikipedia or other information source
	#Chronological Process Breakdown		#Chronological Process Breakdown
	#:''Standard format operations manual similar to those included with consumer and professional devices. Includes images and videos for each operation''		#:''Standard format operations manual similar to those included with consumer and professional devices. Includes images and videos for each operation''

Aidan Williamson: /* Final Product Release Documentation Template for Book/PDF/eBOOK */

2012-06-28T02:40:15Z

Final Product Release Documentation Template for Book/PDF/eBOOK

← Older revision		Revision as of 02:40, 28 June 2012
Line 1:		Line 1:
	=Final Product Release Documentation Template for Book/PDF/~~eBOOK~~=		=Final Product Release Documentation Template for Book/PDF/eBook=

	''This is what a final product release document should contain.''		''This is what a final product release document should contain.''

Aidan Williamson at 02:35, 28 June 2012

2012-06-28T02:35:23Z

← Older revision		Revision as of 02:35, 28 June 2012
Line 58:		Line 58:
	#*Community Q/A Page		#*Community Q/A Page
	#*A Question -> Multiple answer format with best answer voting system		#*A Question -> Multiple answer format with best answer voting system

			=Documentation Process=
			TBD