User Documentation

Date: Sat, 9 Nov 1996 12:59:19 -0400
From: "David L. Potter" <ab934@chebucto.ns.ca>
To: csuite-dev@chebucto.ns.ca

next message in archive
next message in thread
previous message in archive
Index of Subjects



* User Documentation
--------------------------

The user documentation includes the on-line Helpdesk documentation and 
training materials. 

The on-line documentation will be developed within the context of two 
significant strategies: 

 	- local sites will be able to customize the user documentation to fit 
	the local organization (names, addresses, local policies, etc..)  

 	- the on-line documentation will be serve as the basis for a printed 
	user manual that can be sold or otherwise provided to users 

Every effort will be made to facilitate the development of a "universal" 
document set that will spread the maintenance requirement between all CSuite 
sites. The user documentation project will draw, wherever possible, on 
documentation previously developed at all sites that would like to participate 
in this project.    

Format:		The on-line documents are in HTML format. The documents will 
		include a series of  local' elements such as @@@SHORT_NAME@@@ 
		which at Chebucto becomes CCN.  

		The documents will also include hidden elements that will 
		identify the documents relationship to other documents in a 
		printed format. ( eg.  <!-DOC=CH1.9-> )  

		An estimated 250 on-line documents (100 printed pages) will be distributed.

Content:	The core set of on-line documents will cover topics frequently 
		referenced by new users of the CSuite site.

		+ The Helpdesk includes documents which provide orientation with 
		respect to:    

		 	- connecting to the CSuite site
		 	- basic Internet tools such as the WWW browser, e-mail 
				and news readers 
		 	- basic user services such as password and file management
		 	- searching for information
		 	- becoming an information provider

			(rather than say etc... I would prefer interested 
			parties pointed out posible omissions. replies to 
			csuite-doc@chebucto.ns.ca )

		+ Additional documentation will provide a template / framework 
		within which a new CSuite site can develop local policies. 

		+ Training documents will serve as a basis for training programs 
		at new CSuite sites. 


				< end >


---------------------------------------------------------------------
David Potter                 http://chebucto.ns.ca/CSuite/CSuite.html
Documentation Team                             Chebucto Community Net
============== CSuite - Community Network Software ==================



next message in archive
next message in thread
previous message in archive
Index of Subjects