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:

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

How It Works

  • Architecture
  • Installation
  • Configuration
  • Flow of Control
  • CGI parameters — if there are WWW apps involved
  • Database Schema
  • Monitoring

How to Maintain It

  • Ongoing Updates — scheduled updates that aren't automated (yet)
  • Problem Diagnosis

How to Change It

  • Governance
  • Source — where the source resides
  • Coding Standards
  • Revision Control
  • Applying Updates — after changing the source
  • Testing
  • Staging — copying the alpha to the beta version, etc.
  • Dependencies — what else might break if you change this
Edit | Attach | Watch | Print version | History: r7 < r6 < r5 < r4 < r3 | Backlinks | Raw View | WYSIWYG | More topic actions
Topic revision: r7 - 2015-11-08 - BillInce
This site is powered by the TWiki collaboration platform Powered by PerlCopyright © 2008-2024 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback