next message in archive
no next message in thread
previous message in archive
Index of Subjects
* 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. The documentation will include: + an overview document that explains the approach CSuite has taken to issues such as system security, resource utilization, choice of programming tools / languages, etc. + the installation guide + development of a "manual" page for each CSuite script + the CSuite source-browser + Overview The overview document will identify the technical and organizational philosophies that represent the foundation of CSuite. Portions of this document will be based on previous presentations. HTML version will be included in the CSuite "Info Centre". Format: HTML document with an ASCII (printable) version. Content: The technical and organizational philosophies that are the foundation of CSuite. This will include strategies and procedures to maintain / update systems documentation as development continues. + Installation Guide The installation guide is an HTML document that is an integral part of the installation software. Format: HTML Content: The installation guide provides guidance during the installation process. It makes suggestions with respect to the installation of CSuite. + Manual Pages Format: These documents will follow a standard organization (Unix man' page format). They will be developed as HTML documents, and integrated into the source-browser. Content: These documents will include information relating to: general information - overview significant dependencies: module (user functions) programming (environment, other utilities, version, etc.) notes relating to identified security issues possible enhancements (if identified) revision history (as available) + Source Browser The source browser is an automated tool that has been under development for several months. Format: The browser uses an HTML interface and allows the user to view CSuite programs organized by (CSuite) program type. The source browser is updated on an regular basis as determined by the number / extent of revisions within the source code. The source browser creates a document for each CSuite program. Content: Each source browser element includes: a brief description of the program. a link to the source code (allowing authorized personnel to edit the code) a listing (and links to) all the programs that call this program and... a listing (and links to) all the programs that this program calls < end > --------------------------------------------------------------------- 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