|
|
|
|
The first sentence in this kind of topic explains the most important function of the dialog. This introduction should be no longer than a couple of sentences, and usually one sentence is plenty. Introductory text resembles the following:
Use this dialog to add a new EJB control to your web service. An EJB control enables a web service to utilize an Enterprise JavaBean.
Next, include a screen shot of the dialog in question. Do not include any other information in this section. All other information belongs under h2 headings.
The heading should be exactly the same as whatever part of the screen you're describing. For example, if the first pane in the dialog is enh1d XML and there are two tabs in this pane called Parameter XML and Return XML, the first heading should be simply XML and the next two headings should be called Parameter XML and Return XML, and styled in the h3 style.
Descriptions in these sections can be short and sweet. Include all necessary information about the dialog and what you can do with it, but do not explain the concepts behind the functionality any more than necessary. Instead, include links to the appropriate conceptual topics in the Related Topics section .
Describe what to do in this screen element.
 |