The <stepresult> element provides information on the expected outcome of a step. If a user interface is being documented, the outcome could describe a dialog box opening or the appearance of a progress indicator. Step results are useful to assure a user that they are on track, but should not be used for every step as this quickly becomes tedious.

Content models

See appendix for information about this element in OASIS document type shells.


- topic/itemgroup task/stepresult


  <cmd importance="urgent">Once you have the water place it in the microwave.</cmd>
  <info>Try not to spill any, as water is very wet.</info>
 <step importance="required">
  <cmd>Start the Microwave.</cmd>
  <stepxmp>As an example, push the <b>Start</b> button</stepxmp>
  <stepresult>The Microwave starts running. You should hear it humming.</stepresult>
 <step importance="optional">
  <cmd>Once the water begins to boil, stop the Microwave.</cmd>


The following attributes are available on this element: Universal attribute group and outputclass.

Return to main page.