Communications Suite Documentation: Wiki Structure
By Joesciallo-Oracle on Jan 18, 2013
From time to time, I get questions on how to find a particular piece of documentation on the Unified Communications Suite documentation wiki. So I thought it would be useful to give an explanation of our wiki structure and how to approach, at least on one basic level, looking for a particular document.
In a nutshell, we have structured the Communications Suite documentation into two information buckets: "release-specific" content (Release Notes, New Features (formerly What's New), Installation Guides, and Upgrade Guides); and "non-release specific" content (Administration Guides, Developer Guides, Customization Guides, Tuning Guides, and the like). Release-specific content is always located on its own wiki space (in effect, its own web site), whereas the non-release specific content is always on the same "home" wiki space. In terms of URLs, what you have is this:
|Non-release Specific Content
||Release Specific Content
Thus, for each new Communications Suite release, such as Communications Suite 7 Update 2, we publish the aforementioned release-specific content on its own wiki space. The thought here is that customers appreciate having everything they need to install or upgrade a particular release in one location, and don't have to click around to get what they need. Nor do they want to be encumbered by other extraneous content that only gets in the way of the installation or upgrade process.
Notice that the release specific content URLs follow the naming convention CommSuite<v>U<n>, where <v> is the major version and <n> is the update. So knowing that, if, for example, you wanted the release specific documentation for Communications Suite 6 Update 2, you now understand that you would use the following URL: https://wikis.oracle.com/display/CommSuite6U2. Simple, eh?
On the other hand, when dealing with say, administration information, we made the decision to not publish a release-specific Administration Guide for each new Communications Suite version. This is different from other typical publishing environments, where you would expect a new Administration Guide to be published for each new release, even if little to nothing changed. Instead, in the Communications Suite world, you always go to the same guide (you don't have to look around for version x update y of the guide), whose URL remains the same. For example, the Calendar Server Administration Guide is located at https://wikis.oracle.com/display/CommSuite/Calendar+Server+7+Administration+Guide.
So, how do you know if a change was made to a product feature and in what release, you ask? We use a versioning panel to indicate the introduction of a new feature, or a change to an existing feature. Here is an example from the Calendar Server Administration Guide:
So, to summarize:
- If you want release notes, and installation and upgrade information, go to the release-specific wiki for the release that you need.
- For all other content, including administration, customization, developer, and tuning information, go to the "home" (non-release specific) wiki.