外部帮助页External help pages

如果你的应用需要为复杂内容提供详细帮助,请考虑将这些说明托管在网页上。If your app requires detailed help for complex content, consider hosting these instructions on a web page.

何时使用外部帮助页When to use external help pages

对于常规用途或快速参考,外部帮助页不是很方便。External help pages are less convenient for general use or quick reference. 它们适用于涉及面过于广泛而无法合并到应用本身的帮助内容,以及应用的普通受众不会使用的应用高级功能的教程和说明。They are suitable for help content that is too extensive to be incorporated into the app itself, as well as for tutorials and instructions for advanced functions of an app that won't be used by its general audience.

如果你的帮助内容简短或具体到足以在应用内显示,你应该这样做。If your help content is brief or specific enough to be displayed in-app, you should do so. 除非有必要,否则不要引导用户在应用之外获取帮助。Do not direct users outside of the app for help unless it is necessary.

当将用户引导到外部帮助页时,请采用以下两种方案之一:When a user is directed to an external help page, follow one of two scenarios:

  • 直接将他们链接到对应于其已知问题的页面。They are linked directly to the page that corresponds with their known issue. 这是上下文帮助,应尽可能使用。This is contextual help, and should be used when possible.
  • 将他们链接到常规帮助页,其中清晰显示类别和子类别供他们选择。They are linked to a general help page, with a clear display of categories and subcategories to choose from.

向用户提供搜索你的帮助的方法可能非常有用,但不要使此搜索成为导航你的帮助的唯一方式。Providing users with a way to search your help can be useful, but do not make this search the only way of navigating your help. 有时用户可能难以描述其遇到的问题,这可能使搜索变得困难。It can sometimes be difficult for users to describe their problems, which can make searching difficult. 用户应该能够快速找到与他们的问题相关的页面,而无需进行搜索。Users should be able to quickly find pages relevant to their problems without needing to search.

教程和详细演练Tutorials and detailed walkthroughs

外部帮助页是向用户提供教程和演练的理想位置,无论是视频还是文本。External help pages are the ideal place to provide users with tutorials and walkthroughs, whether video or textual.

  • 教程应侧重于介绍更复杂的概念和高级功能。Tutorials should focus on more complicated ideas and advanced functions. 用户应不需要教程就可以使用你的应用。Users shouldn't need a tutorial to use your app.
  • 确保这些教程显示的内容不同于标准帮助说明。Make sure that these tutorials are displayed differently from standard help instructions. 相较于想要直接获取其问题的解决方案的用户,要查找高级说明的用户更渴望搜索它们。Users who are looking for advanced instructions are more eager to search for them than users who want straightforward solutions to their problems.
  • 请考虑从目录和从对应于每个教程的单个帮助页面链接到教程。Consider linking to tutorials from both a directory and from individual help pages that correspond to each tutorial.