Hello again,
I have another "Best Practices" question that is causing some debate at my organization.
DITA allows the use of the <keyword> element within <uicontrol> and several other User Interface elements (not <wintitle>). Authors are split as to whether it is a best practice use a variable for the product name and then use that variable within a <uicontrol>.
I have no problem using a variable for the product name and actually encourage other writers to do so. I do have an issue with using any variable within the <uicontrol>. A <uicontrol> is static text on the product console and any changes to the UI control should be manually applied. I view the manual updating of both the console and the <uicontrol> elements in the documentation as a necessary quality control step.
Using the variable in the control allows for more chance of inconsistency between the document and the console. Just because the product name changes, that does not mean that the developers will catch every instance on the UI, or that every control will maintain its previous wording.
Have any best practices been developed relating to the use of variables within user interface controls?
Thanks,
Mike