Share via

Cross-References 

  • Article

Use cross-references to direct users to Help or another resource.

  • Cross-references to Help should not refer to specific topic titles.

    • If the Help topics are included in Windows Help and Support Center, use the following boilerplate text:
      For more information about <insert a rewording of the Help topic title, so the user knows what to look up>, see Help and Support.

    • If the component has its own Help separate from Help and Support Center, use this boilerplate text:
      For more information about <insert a rewording of the Help topic title, so the user knows what to look up>, see <insert feature name of the stand-alone chm> Help.

      Examples

      For Help and Support Center

      For more information about repairing disk errors, see Help and Support.

      For component Help

      For more information about repairing Directory Synchronization Services, see MSDSS Help.

    • Use "for more information about" instead of "for more information on."

  • Avoid using URLs in UI if possible. However, if they must be used, follow these guidelines.

    • Include a cross-reference to a URL to point users to related but nonessential information that may add to their understanding of a concept. Balance the usefulness to users against the knowledge that URLs can quickly become obsolete. Direct users to the least specific entry point in the site that can link them to the needed information.

    • Position the cross-reference as the last line of a paragraph. Always put the URL on a separate line, preceded by a colon, as shown in the following example, but do not put the cross-reference on a separate line. Use a trailing slash in a URL unless the final element is a file name, such as "filename.htm." When adding a trailing slash, be sure to test the URL to make sure that this doesn't change the address. Do not follow the URL with any other punctuation.

      Correct Incorrect

      UI should not convey information by color alone. For more information, visit the Microsoft Accessibility Web site at:

      https://www.microsoft.com/enable/

      UI should not convey information by color alone. See https://www.microsoft.com/enable for more information.