next message in archive
no next message in thread
previous message in archive
Index of Subjects
I have posted this to csuite-dev for the benefit of any community network board members who are not subscribed to csuite-doc david potter CSuite Documentation Project ============================================= We are pleased to announce that funding has been provided for a documentation project associated with the Chebucto Suite (CSuite Community Network) Software. The documentation project is scheduled for completion in February 1997. >>>>Your attention is directed to two specific areas:<<<< CSuite Internals -------------------------- CSuite (or potential) sites who would like to participate in the ongoing development of CSuite (eg. new or custom services...) are invited to bring forward their "developers wish list" with respect to the documentation of CSuite internals. (our proposal will follow) $$$ for User Documentation $$$ --------------------------------- Portions of the budget for User documentation can be distributed to other sites who are able to contribute documents to a universal document pool. Please direct $$$ Inquiries to csuite-admin@chebucto.ns.ca Individual outlines of the three documentation projects will be posted to both csuite-dev and csuite-doc Subsequent discussion should be directed to csuite-doc@chebucto.ns.ca =-=-=-=-=-=-=-=-=-=-=-==-=-=-=-=-=-=-=-=-==-=-=-=-=-==-=- The documentation project has three distinct elements: * systems documentation * administration documentation * user documentation Each of these elements has a specific action plan. * Systems Documentation ------------------------------- Aimed primarily at a technical audience. This documentation will provide a foundation upon which portions of the ongoing development of CSuite can be undertaken at other sites. * Admin Documentation ------------------------ This documentation is aimed at a less technical audience. In most instances the reader is not a programer but may be responsible for administration duties including account activation, the authorization of custom user id's or additional disk quota. This documentation should serve as a bridge between the underlying policies and the interface used by both administrators and the user. Admin documentation should also provide limited diagnostic elements that will provide a non-technical (trusted) volunteer with trouble shooting aids... "When should I call the techs?" * 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 any sites that would like to participate in this project. --------------------------------------------------------------------- David Potter http://chebucto.ns.ca/CSuite/CSuite.html Documentation Team Chebucto Community Net ============== CSuite - Community Network Software ==================
next message in archive
no next message in thread
previous message in archive
Index of Subjects