Types of OLE Documentation

Implementation Guide Documentation - This explains how to prepare your data and install OLE.
User Documentation - This explains the functional purpose of a feature and how end-users would expect to interact with the feature.
Technical Documentation - This explains how a core feature is designed and built. This is of importance to core contributing developers and others who may want to extend a feature.

Implementation Guide Documentation Expectations

Content

Explains steps to take to organize and load data. Tips and case studies to assist new implementers should be included here
Data tables should live here

Location

Available on the wiki, link is in the left pane navigation

User Guide Documentation Expectations

Content

A description of the feature and how it would be used by an end-user of OLE
Screenshots of the feature
Available within the the system's help links

Location

Drafts can be uploaded to the appropriate release in the Google Drive folder: OLE Documentation
Final versions are available from OLE Published Documentation

Technical Guide Documentation Expectations

Content

Conceptual/architectural diagram showing how the core feature was built - with explanation
- Includes illustrating how this feature interacts or relates to other features
Class diagram showing how the core feature was built - with explanation
Database diagram (ER) showing how the DB was designed - with explanation
A text based description of why the feature was designed the way it was
Includes rules, permissions, and roles for each feature

Location

See the Technical Documentation Project Plan for links to each document
Links to completed documents are available with the published User Documentation

Expectations of Contributing Developers

Contributing developers regardless of work type (bug, enhancement, etc), are expected to share some responsibility in documenting any new features or changes that are made, in a consistent fashion laid out by the documentation policies above.

In most cases, the contributing developer will be responsible for a basic first cut at all four types of feature based documentation.

Types of OLE Documentation

Implementation Guide Documentation Expectations

Content

Location

User Guide Documentation Expectations

Content

Location

Technical Guide Documentation Expectations

Content

Location

Other Documentation

Contribution Policies

Content

Location

Development Team

Content

Location

Anything Else

Expectations of Contributing Developers

Browser not supported