ユーザー操作の結果を書く <stepresult>

stepresult要素には、ユーザーが行った1つの操作(行為)に対する結果を書きます。

cmd要素とstepresult要素は対になります。ユーザーがcmd要素に書いた操作を行うことによって、stepresult要素に書いた結果がもたらされます。したがって、cmd要素はユーザーの視点で、stepresult要素は製品やシステムの視点で書きます。

stepresultを書くことにより、手順が期待どおりに進んでいることを、ユーザーが容易に確認できるようになります。しかし、すべての操作にstepresultを書くと冗長になるので、大切な箇所や操作の成否が分かりにくいステップについてだけ、stepresultを記述すべきです。

stepresult要素の記述例

<task id="execute_by_ant" xml:lang="ja-jp">
    :
  <taskbody>
    <prereq> ... </prereq>
    <context> ... </context>
    <steps>
       :
      <step>
        <cmd>DITA Open Toolkitを実行するために、コマンドプロンプトに以下のコマンドを入力します。</cmd>
        <info><screen>&gt;<userinput>ant -f <varname>xxxx_xhtml</varname>.xml</userinput></screen>
          <parml>
            <plentry>
              <pt><varname>xxxx_xhtml</varname>.xml</pt>
              <pd>Antスクリプト・ファイルのファイル名</pd>
            </plentry>
          </parml>
        </info>
        <stepxmp>実行例:<screen>C:\DITA-OT1.4.3\doc\userguide&gt;<userinput>ant -f DITA-userguide_xhtml.xml</userinput></screen></stepxmp>
        <stepresult>DITA Open Toolkitの実行が完了すると、コマンド・プロンプトに以下のようなメッセージが表示されます。
          <screen>BUILD SUCCESSFUL Total time: <varname>xx</varname> seconds C:\DITA-OT1.4.3\doc\userguide&gt;</screen>
        </stepresult>
      </step>
      :
    </steps>
    :
  </taskbody>
</task>