Abstract: [Supply your own summary of the technical purpose of the document.]


Download 41.66 Kb.
NameAbstract: [Supply your own summary of the technical purpose of the document.]
A typeDocumentation
manual-guide.com > manual > Documentation





UDDI Spec TC

Best Practice

Provide subject - see File>Property>Subject Field

Document identifier:

13083.doc

Location:

http://www.oasis-open.org/committees/uddi-spec/doc/bp/13083.doc.doc

[File name convention: "uddi-spec-tc-bp-xxx-200ymmdd" - where xxx represents the topic. Filenames use all lower case.]

Author:

[List your authors here; check whether “Author” header should be plural]
Editors:

[List your editors here]
Contributors:

[List your contributors here]

[Optionally list them in the Acknowledgments appendix instead]
Abstract:

[Supply your own summary of the technical purpose of the document.]
Status:

[Describe the status and stability of the best practice and where to send comments.] This document is updated periodically on no particular schedule. Send comments to the editor.

[This is boilerplate; to use, fix the hyperlinks:] Committee members should send comments on this best practice to the uddi-spec@lists.oasis-open.org list. Others should subscribe to and send comments to the uddi-spec-comment@lists.oasis-open.org list. To subscribe, send an email message to uddi-spec-comment-request@lists.oasis-open.org with the word "subscribe" as the body of the message.

[This is boilerplate; to use, fix the hyperlinks:] For information on whether any intellectual property claims have been disclosed that may be essential to implementing this best practice, and any offers of patent licensing terms, please refer to the Intellectual Property Rights section of the UDDI Spec TC web page (http://www.oasis-open.org/committees/uddi-spec/).

Table of Contents

Introduction 3

1.1 Problem statement 3

1.2 Terminology 3

2 Best Practice Solution 4

2.1 Definitions 4

2.2 Best Practice behavior 4

2.3 Discussion 4

2.4 Web Service type definition (optional) 4

2.5 Example 4

3 Word Styles - Remove this section 5

3.1 Overall Style 5

3.2 Title Page 5

3.3 Headings 5

3.4 Paragraphs 5

3.5 Lists 5

3.6 Tables 6

3.7 Code Examples 6

3.8 Character Styles 6

4 References 7

4.1 Normative 7

Appendix A. Acknowledgments 8

Appendix B. Revision History 9

Appendix C. Notices 10


Introduction


[Place a general summary of the best practice here to serve as executive summary enticing the reader to read on. Highlight the business problem, specific application of UDDI, and the benefits achieved by implementing this best practice with respect to UDDI.]

1.1Problem statement


[Describe the business or technical problem or situation which application of your recommendations will address. Try to include metrics which will help others understand to problem more clearly, and which will help you explain the value of your recommended solution.]

1.2Terminology


[The following is boilerplate. Most best practices will need this and the corresponding bibliography entry.] The key words must, must not, required, shall, shall not, should, should not, recommended, may, and optional in this document are to be interpreted as described in [RFC2119].

2Best Practice Solution

2.1Definitions


[Use this section to list any technical definitions required by the reader in order to understand the proposed best practice below. ]

2.2 Best Practice behavior


[In this section discuss in detail your recommendation in sufficient technical depth to permit their adoption by others. Include charts, technical diagrams, process outlines, or any other illustration, which may better explain the UDDI implementation.]

2.3 Discussion


[In this section you should discuss your recommendations. Explain the logic behind the recommendation, review the alternatives you considered and the logic behind your ultimate choice, delve into the ramifications of adoption and implementation of your recommendations, etc..]

2.4 Web Service type definition (optional)


[In this section you should supply any service type definitions (tModels) required to apply your recommendations. ]

2.5 Example


[In this section you should provide a detailed example illustrating application of your recommendations.]

3Word Styles - Remove this section


[This section is provided to explain and demonstrate the styles available in the Word template attached to this sample document. It is important to use the styles provided in the template consistently and to avoid defining new styles or using raw formatting.

Delete this entire section when using this sample document to begin writing a new best practice.]

3.1Overall Style


The paper size is set to Letter, which is 8 ½ x 11. You may change this to A4 or whatever other size suits your needs.

The document identifier and publication date information in the footer needs to be updated every time you publish.

Line numbers are enabled by default for easy reference by best practice commenters. You may turn line numbering off.

3.2Title Page


The title page is designed to fit a lot of metadata compactly. If you wish to create a “true” title page, you may insert a page break after the subtitle.

3.3Headings


Heading 1 through Heading 9 and AppendixHeading have been defined with a special appearance. Headings are numbered and appear in the Table of Contents. Pressing Return after a heading inserts a Normal paragraph style directly after.

This template sets Heading 1 and AppendixHeading to start on a new page. You may set the Heading 1 style not to start on a new page if you wish. Major headings have a horizontal rule above them.

3.4Paragraphs


The font in the Normal paragraph style is 10-pt Arial. You may change this to 11-pt Times New Roman if you prefer a serif font; changing these two settings should change all the other relevant styles.

3.5Lists


The Definition term and Definition paragraph styles are defined specially for this template. They produce a definition list with a hanging appearance. Pressing Return after one inserts the other directly after.

Definition term

Definition for the term.

Use List bullet for first-level bulleted lists. Use List bullet 2 for second-level bulleted lists. Use List continue for continued paragraphs in list items.

  • List bullet

List continue.

  • List bullet 2

List continue 2.

For bibliography lists, use the Ref paragraph style. Use the Ref term character style for the bracketed text that serves as the bibliography entry key, and make each reference term into a bookmark for use as references from the text. For example, [RFC2119] is a generated cross-reference to the IETF RFC 2119 bibliography entry in Section 4.1 of this sample.

3.6Tables


Use the following style for most tables: [To be supplied; suggestions welcome!]

3.7Code Examples


For schema code and other normative code, use the Code paragraph style. It fits 71 characters. For example:

12345678901234567890123456789012345678901234567890123456789012345678901

1 2 3 4 5 6 7















Use the Code small style if the code has very long lines. It fits 80 characters. For example:

12345678901234567890123456789012345678901234567890123456789012345678901234567890

1 2 3 4 5 6 7 8















For non-normative examples, use the Example paragraph style. For example:

GET http://?TARGET=...



Use the Example small style if the example has very long lines. For example:

GET http://?TARGET=...


3.8Character Styles


This template defines several character styles for general text use:

  • Element style (shortcut Ctrl-Shift-E) for names and names; add the angle brackets yourself

  • Attribute style (shortcut Ctrl-Shift-A) for attributeNames

  • Datatype style (shortcut Ctrl-Shift-Alt-D) for DataType names

  • Keyword style (shortcut Ctrl-Shift-K) for OtherKeyword names

  • Variable style (shortcut Ctrl-Shift-Alt-V) for variable names

4References


[This section should list any references to publicly available documents that the reader may find helpful during reading of this Best Practiced document. These documents may expand upon any aspect of the material, for instance they may provide additional insight into the business situation dealt with or they may document standards or products used in developing the solution.]

4.1Normative


[RFC2119] S. Bradner, Key words for use in RFCs to Indicate Requirement Levels, http://www.ietf.org/rfc/rfc2119.txt, IETF RFC 2119, March 1997.
  1. Acknowledgments


The following individuals were members of the committee during the development of this best practice:
  1. Revision History


[This appendix is optional, but helpful.]

Rev

Date

By Whom

What






































  1. Notices


OASIS takes no position regarding the validity or scope of any intellectual property or other rights that might be claimed to pertain to the implementation or use of the technology described in this document or the extent to which any license under such rights might or might not be available; neither does it represent that it has made any effort to identify any such rights. Information on OASIS's procedures with respect to rights in OASIS specifications can be found at the OASIS website. Copies of claims of rights made available for publication and any assurances of licenses to be made available, or the result of an attempt made to obtain a general license or permission for the use of such proprietary rights by implementors or users of this specification, can be obtained from the OASIS Executive Director.

OASIS invites any interested party to bring to its attention any copyrights, patents or patent applications, or other proprietary rights which may cover technology that may be required to implement this specification. Please address the information to the OASIS Executive Director.

Copyright © OASIS Open 2003. All Rights Reserved.

This document and translations of it may be copied and furnished to others, and derivative works that comment on or otherwise explain it or assist in its implementation may be prepared, copied, published and distributed, in whole or in part, without restriction of any kind, provided that the above copyright notice and this paragraph are included on all such copies and derivative works. However, this document itself may not be modified in any way, such as by removing the copyright notice or references to OASIS, except as needed for the purpose of developing OASIS specifications, in which case the procedures for copyrights defined in the OASIS Intellectual Property Rights document must be followed, or as required to translate it into languages other than English.

The limited permissions granted above are perpetual and will not be revoked by OASIS or its successors or assigns.

This document and the information contained herein is provided on an “AS IS” basis and OASIS DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.

13083.doc

Copyright © OASIS Open 2003. All Rights Reserved. Page of

Share in:

Related:

Abstract: [Supply your own summary of the technical purpose of the document.] iconAbstract: [Supply your own summary of the technical purpose of the document.]

Abstract: [Supply your own summary of the technical purpose of the document.] icon[Type the abstract of the document here. The abstract is typically...

Abstract: [Supply your own summary of the technical purpose of the document.] iconAbstract (Document Summary)

Abstract: [Supply your own summary of the technical purpose of the document.] iconAbstract Here you are to summarize the contents of this paper. This...

Abstract: [Supply your own summary of the technical purpose of the document.] icon1introduction 1Purpose and Scope This section provides a brief description...

Abstract: [Supply your own summary of the technical purpose of the document.] iconAbstract this compendium document identifies many standards, other...

Abstract: [Supply your own summary of the technical purpose of the document.] iconAbstract Here you are to summarize the contents of this paper. This...

Abstract: [Supply your own summary of the technical purpose of the document.] iconThe purpose of this document is to provide you with a guideline for...

Abstract: [Supply your own summary of the technical purpose of the document.] iconListed document this document shall not be revised without approval...

Abstract: [Supply your own summary of the technical purpose of the document.] icon1. Organizations use this transaction set to order items of supply,...

Abstract: [Supply your own summary of the technical purpose of the document.] iconPurpose of this document

Abstract: [Supply your own summary of the technical purpose of the document.] iconSection 0 Purpose of Document

Abstract: [Supply your own summary of the technical purpose of the document.] iconIntroduction Purpose of the document

Abstract: [Supply your own summary of the technical purpose of the document.] icon14. Performance Requirements Summary 11 overview purpose

Abstract: [Supply your own summary of the technical purpose of the document.] icon1Introduction 1Backup and Recovery Document Purpose

Abstract: [Supply your own summary of the technical purpose of the document.] iconTechnical Summary sap releases

Abstract: [Supply your own summary of the technical purpose of the document.] iconObjective Position involving writing and software, video, and/or...

Abstract: [Supply your own summary of the technical purpose of the document.] iconAdvantech ae technical Share Document

Abstract: [Supply your own summary of the technical purpose of the document.] iconThis document demonstrates some of my technical skills

Abstract: [Supply your own summary of the technical purpose of the document.] iconThe information contained in this document is confidential and is...




manual


When copying material provide a link © 2017
contacts
manual-guide.com
search