Public:MUG Instructions

From wiki.opentravel.org

Below is guidance on how to populate the Message User's Guide (MUG).

Contents 1 The Use Case 1.1 Use Case Request 1.2 Use Case Request Instance 1.3 Use Case Response 1.4 Use Case Response Instance 2 Use Case Template 3 Lessons learned in creating the instances

[edit] The Use Case

This should contain the detailed information about the conversational exchange. This information is not generic. It is the actual instance information. You should be able to perform a one-to-one data check between verbiage and the instance document request and response; conversely you should not have additional details in the instance document not present in the verbiage.

[edit] Use Case Request

[edit] Use Case Request Instance

[edit] Use Case Response

[edit] Use Case Response Instance

[edit] Use Case Template

For your convenience and to promote standardization, OpenTravel asks that you utilize our Use Case Template (.doc).

[edit] Lessons learned in creating the instances

• Use the code list for any attributes of OTA_CodeType
• Make sure your version attribute matches your Schema
• Make sure your use cases match your instances and your instances match your use cases
• Don’t submit empty elements
• If you find any issues -- your data doesn’t fit, you can’t find a code -- make sure to report it to the workgroup

Of course, it is always a good idea to look at the current Message Users Guide to get an idea of what others have done.