Online Help Template

[Delete all text in brackets.

If this document applies to only Aria6 or to both Aria6 and Aria 7 (Crescendo), delete the DekiScript at the top of this page.

Use this functional documentation template to describe a single-topic feature (standalone feature or one phase in a multi-phase process). A procedure describes how to use a feature.

Write the procedure by completing the Overview, Best Practices, and Instructions sections in this template as described below. Follow the quality standards described below when creating any type of documentation.

Provide links to any relevant supplementary/reference information in the list of related topics at the bottom of the page.

To describe a multiple-topic feature (that involves a multi-phase process), use the process template.]

Overview

[Document background/introductory information. Describe what the topic is about, what the feature is, why you would use it, context, and feature benefits. Avoid repeating information that already exists in a concept topic. Instead, just include a link to the concept topic in the procedure overview.

Example overview:

• Prevents interruption of customer service due to non-payment;
• Reduces customer cancelation by maintaining the payment relationship;
• Minimizes costs associated with collections and with updating accounts manually;
• Keeps the update process transparent to customers."]
   

Best Practices

[If applicable to the feature, list any relevant best practices (recommended actions to achieve the best results).   

Example best practices:

Event Notification Best Practices:

• Subscribe only to events that you need to be informed of. If you subscribe to a large number of events that you don’t require, that may slow down your Aria implementation.
• Send your event notification data to only trusted parties. Sending data to third parties may compromise the privacy of your customers’ information.
• Restrict access to the Event Notification section of Aria to only authorized individuals.]

Instructions

[Write out the steps for using the feature. Follow these guidelines for writing instructions:

• Use action-oriented wording/active voice in instructions. However, do not use active voice at the expense of clarity.
• Use simple, concise, English wording as much as possible without sacrificing accuracy. Avoid foreign-sounding words such a "vis-a-vis" or "in lieu", which may be difficult to understand.
  
  Example: write "Use a $0 authorization instead of a $1 authorization if you want to reduce the financial impact on a customer." instead of "Employ a $0 authorization in lieu of a $1 authorization if you are endeavoring to minimize the financial impact on the parties to whom you provide services. A $0 authorization will have an infinitesimal effect on your clientele."
   
• Where applicable, use bulleted lists, tables, or diagrams to simplify complex information.
• Add sample scenarios, tips/tricks, downstream effects, and/or warnings to the relevant steps in the instructions, if applicable.
• If there are more than 10 steps in a procedure, break it up into phases, or if applicable, into separate procedures. Examples: use sub-sections in functional documentation or split process flow diagrams into phases.

Example instructions: Update a Plan Instance's Rate Schedule]