SoftwareDeveloperDocumentationTemplate < CF

CF Web>SoftwareDeveloperDocumentationTemplate (2015-11-08, BillInce) (raw view)

---+ Software Developer Documentation

For systems we use and develop or modify ourselves,
we have this template for needed documentation.
Whether each of the following is a separate page, or not,
is specific to the size of the documentation.

Whether all categories are included depends upon the software.
E.g. if it's not a CGI, then there will be no CGI parameters to document.
And if it doesn't use a database, then there will be no schema to document.

Examples of this are:
   * [[https://cs.uwaterloo.ca/cscf/internal/ST/beta/doc/internals][ST]]
   * ?

This is (as of 2015-09) a work in progress.

<hr>

---++ How It Works
   * Architecture
   * Installation
   * Configuration
   * Flow of Control
   * CGI parameters &mdash; if there are WWW apps involved
   * Database Schema
   * Monitoring

---++ How to Maintain It
   * Ongoing Updates &mdash; scheduled updates that aren't automated (yet)
   * Problem Diagnosis

---++ How to Change It
   * Governance
   * Source &mdash; where the source resides
   * Coding Standards
   * Revision Control
   * Applying Updates &mdash; after changing the source
   * Testing
   * Staging &mdash; copying the alpha to the beta version, etc.
   * Dependencies &mdash; what else might break if you change this

Topic revision: r7 - 2015-11-08 - BillInce

Information in this area is meant for use by CSCF staff and is not official documentation, but anybody who is interested is welcome to use it if they find it useful.

Other Webs

My links
- People
- CERAS
- WatForm
- Tetherless lab
- Ubuntu Main.HowTo
- eDocs
- RGG NE notes
- RGG
- CS infrastructure
- Grad images

Edit