Difference between revisions of "User:Aeric/Wiki Versions and Task Processing"

From AgileApps Support Wiki
imported>Aeric
imported>Aeric
Line 29: Line 29:


===Releases===
===Releases===
Release numbers aren't of much use in the cloud, so cloud releases have dates. Those dates are shown in the Release Notes page in the Wiki. For example: <tt>13 Jan 2014</tt>.
For the installable versions, on the other hand, release numbers are more valuable. So an installable release is given a number. That release encompasses all of the dated updates from the last installable release up to the current release date.
The Release Notes for a new instance of the installable version contain:
:* Items that are specific to the installable instance (for example, the ability to add MIME types)
:*
:* The collection of applicable new features from the cloud-version release notes.
:: {{TBD|}}
{{TBD|We need to find a way to add a "water mark" to the release notes, when an installable version is released. That will make it easier to identify the features that need to be called out for Installable Version Release Notes. We could:
:* Point to the cloud version and tell the installer which dates are relevant.
:* Have features for each date in its own page and transclude the appropriate dates
:* or (easiest) start a new Release Notes page whenever an installable version is released.}}


==Strategies for Documentation Tasks==
==Strategies for Documentation Tasks==

Revision as of 00:50, 20 December 2013

The existence of multiple products, multiple versions of those products (cloud and installable), multiple releases, and a Wiki for each combination of product-version of them creates a need to strategize the processing of documentation tasks. This article provides an overview of the Wiki space and outlines those strategies.

This diagram summarizes the information:

File:ProductsAndVersions.png

The Wiki Space

Products

The basic products are AgileApps, focused on case management, and LongJump -- it's historical predecessor. Many features overlap between those two, and sometimes new features apply to both. But many features are unique to AgileApps, including:

  • Case Management
  • Communication Channels (including social media)
  • Overhauled GUI
  • Multi-lingual, Accessible interface with localization features

Notepad.png

Note: AgileApps has a different interface. So even when the page that provides that functionality is the same, the "how to get here" paths that are part of the procedural steps found in the "Working with" sections will be different.

Versions

There are two versions of each product, the cloud version and the installable version:

  • The Wiki that corresponds to the cloud version is updated every 2 or three weeks with new features.
  • The Wiki that corresponds to the installable version is a snapshot of the cloud wiki taken a little before or after the installable release.

The cloud version is always accessed using a "/wiki" URL:

  • agileappslive.info/wiki for AgileApps
  • platformatyourservice.com/wiki for LongJump.

Installable versions are accessed using an identifier and a version number in place of "/wiki".
For example: /lj90 or /aal10.

Releases

Release numbers aren't of much use in the cloud, so cloud releases have dates. Those dates are shown in the Release Notes page in the Wiki. For example: 13 Jan 2014.

For the installable versions, on the other hand, release numbers are more valuable. So an installable release is given a number. That release encompasses all of the dated updates from the last installable release up to the current release date.

The Release Notes for a new instance of the installable version contain:

  • Items that are specific to the installable instance (for example, the ability to add MIME types)
  • The collection of applicable new features from the cloud-version release notes.
__TBD__

__TBD: We need to find a way to add a "water mark" to the release notes, when an installable version is released. That will make it easier to identify the features that need to be called out for Installable Version Release Notes. We could:

  • Point to the cloud version and tell the installer which dates are relevant.
  • Have features for each date in its own page and transclude the appropriate dates
  • or (easiest) start a new Release Notes page whenever an installable version is released.__

Strategies for Documentation Tasks

Critical Fixes

"Cosmetic" Improvements

New Features