Doc-Guiding Principles

This page of the documentation provides the current guiding principles that govern the decisions regarding implementation approaches and decisions for the OESChapters.org (OESC) website.

In the website creator’s opinion, to be an effective, realistic, and maintainable environment, the OESC website must:

  1. Be based on a sound design that is:
  • Inherently extensible to handle multiple Chapters and Jurisdictions.
  • Consistent across all participating Chapters so that the “look and feel” is the same even though the detail content will vary from Chapter to Chapter.
  • Robust with all appropriate capabilities and features, such as calendars, newsletter archives, appropriate blog capabilities, and membership listings.
  • Providing for both public and Chapter-member-private content so that member personal data is appropriately protected from public non-member viewing.
  • Providing robust access control so that only appropriately permitted users can make changes to the content of the environment and view member-private data.
  • Supportive of effective operation with a minimum of computing resources to keep operating costs at a minimum.

2. Be maintainable in that it:

  • Uses only commercially available off-the-shelf software, and the minimum necessary amount if it.
  • Has no or the barest minimal amount of “custom coding” so that no special technical skills are required to maintain the environment by either the initial webmaster or any subsequent maintaining individual.
  • Is systematically implemented so there are no “special cases” or “hidden tricks” or any non-standard programming techniques involved.

3. Be comprehensively documented so that:

  • The design and implementation is clearly communicated to anyone who needs the information.
  • The internal component naming standards and conventions are clear, consistently applicable, and effective to prevent any naming confusion.
  • Comprehensive “see-spot-run” operating procedures exist to handle all normal and foreseen maintenance actions of the environment so that anyone with basic computer skills who can read common English can safely and effectively maintain the environment.

4. Survive the availability of the initial website creator and be readily assumable by a subsequent webmaster when/if that becomes necessary. The website must not “die with the creator’s lack of availability”.