New in This Document

Use the New In This Document topic in the following situations:

• You are republishing an existing RUCKUS document for a new or updated release.
• You are adding, updating, or deleting features in existing RUCKUS documents.
• You are adding, updating, or deleting commands to a command reference document.
• The New in This Document topic should not be used as a Document History table.
• The New In This Document topic should not be used for Command Reference Guides.
• If there are no changes in the document, there should be no indication in the table to the effect that “No changes or updates were made to the guide.” Nor should the table show “None” in the rows. Doing so leaves the reader to wonder why the document was rereleased if there were no changes to it. You want to also avoid leaving the table cells blank.
• For complete New In This Document guidelines see https://commscope.sharepoint.com/:b:/r/sites/ARR_CSS/TechPubs/SDL/Documents/new-in-this-document-guidelines-v1.0.pdf

The New in This Document section normally appears in the About This Document chapter.

The Key Features and Enhancements table is the main feature of the New in This Document section.

The table title includes the release number (and version number if warranted) and the publication date of the document, as shown in the following example.

• Feature Column

  The Feature column shows the name of each new, updated, or deleted feature in a separate row.

• Description Column

  The Description column shows a brief description of the new, updated, or deleted feature.

  The Description need not be too lengthy. Begin each description with the notation New, Updated, or Deleted before including a description of the feature or change.

  Note: Keep in mind that the descriptions are likely to be used in the release notes too.

• Reference Column

  The Reference column shows a cross-reference (live link whenever possible) to the appropriate section in the document.

There must be some indication of what has been updated in the released document because there must be some form of change that requires the republication of the document. For documents in which there are no new features or only minor changes, some mention of updates to the guide should be included in the table. For example, some forms of general updates could be listed in the following ways:

• Editorial updates and corrections
• Addressing reported defects
• Unsupported software
• Unsupported hardware
• Unsupported feature

The reference to these types of changes could be “Throughout the guide” or “References have been removed throughout the guide.” The goal is to indicate that the change or deletion has occurred throughout the document.