将文档构建到软件中

时间:2013-06-20 23:17:09

标签: user-interface documentation user-experience

我见过几个应用程序,它们在用户首次使用时向用户解释功能,或在升级后引起新功能的注意。这种文档直接出现在应用程序中以及用户流程中,例如通过在UI上放置一个指向按钮或任何其他元素的语音气泡。通常它会出现一次而且永远不会再出现。

enter image description here

不幸的是,我不知道如何调用这种方法,这使得它甚至难以谷歌。它似乎是一种非常现代的用户体验方式。

我想知道使用了哪些架构或设计模式,或者是否有任何值得注意的库来实现它。我试图解决的问题是,这是一个贯穿整个工作流程中任何地方和任何时间的跨领域事物 - 但是你想要将整个问题保持在“实际”功能之外。

例如,用户可能会在MVC webapp中请求页面。控制器获取数据,执行操作并提供视图。在该视图上是一个新选项卡。用户从未见过这个,你想要显示一条友好的消息“点击这里......”。这意味着在某些地方,可能在控制器中,您必须检测到尚未向用户解释此功能 - 您从捆绑包中加载消息并将其发送到视图。除了选项卡之外,视图还会呈现语音气泡。该逻辑与实际功能无关。理想情况下,您可以将其保留在控制器和视图之外。

我在想是否面向方面编程方法可以提供帮助。

是否有博客,图书馆,既定模式?

请注意:我不是在问如何渲染讲话泡泡。我担心的是我不想要逻辑 - 决定何时显示它(“用户有没有看过消息?他们选择了”不再显示?“),要显示的内容以及显示位置 - 分布在整个应用程序源代码中。理想情况下,它可以打包到自己的包或项目中。

类似的注意事项可以应用于收集功能使用统计信息或在各个地方添加用户反馈渠道。

更新:我终于得到了一个答案,正是我要找的东西。由于找到一个术语是主要问题,我在Shahrokh的答案中添加了一些关键词,以帮助未来的读者找到这个Q& A:这个东西可以称为介绍,循序渐进的指南,页面指导,或首次用户的导游网站导览;答案包括intro.js,aSimpleTourPlugin,pageguide.js,joyride,Codrops,Bootstro.js,jQuery SiteTour,jQuery Tourbus,Trip.js和Crumble。

1 个答案:

答案 0 :(得分:4)

您网页的网页用户指南网站导览列表为here