如何pipe理Android应用程序的用户文档?

来自Linux桌面世界,我将被用来写我的应用程序的用户文档作为一套Markdown / docbook /任何文件,在生成时生成相应的HTML文件,并与我的应用程序一起分发,以便被浏览用yelp,kchmviewer,Okular或类似的帮助查看器(我们正在讨论基于GUI的应用程序,比如Gnome和KDE,所以这里不包含manpages和info页面)。

Android不提供这样的东西。 没有官方支持的build议/强制性方式来创build,pipe理和分发最终用户的文档(至less是AFAIK)。 这个任务没有工具(把Web浏览器和/或webview放在一边)。

目前,我们正在维护一组HTML文件(与源代码树完全独立),我们只是向用户提供一个链接,以便在网上阅读(如果屏幕大小允许这样的阅读,或来自不同设备)。

替代似乎是:

  1. 把所有的东西放在/资产或/ res目录中

  2. 将用户的index.html页面显示到默认的Web浏览器中(或者在WebView中,在对话框内),让他浏览剩余的文档。

有没有人知道更好(更有组织,更好的工程)的方式来创build,pipe理和分发Android应用程序的用户文档?

是的:我知道,移动应用程序通常预计几乎完全自我logging(即:用户界面在没有任何其他帮助的情况下以正确的方式引导用户)。 不幸的是,我们正在开发一些需要一些先前知识才能使用的东西。

Solutions Collecting From Web of "如何pipe理Android应用程序的用户文档?"

像“展示视图”的东西可能有助于解释简单的用户界面元素。 在GitHub上有很好的实现: https : //github.com/Espiandev/ShowcaseView

该库将为某些元素生成覆盖图,并且可以将其configuration为只显示一次。 以下是文档中的一个示例:

ShowcaseView示例

我已经看到了应用程序(例如Android上的Astrid任务pipe理器 ),其中包含第一次使用该应用程序的用户的演练。 它们在GUI的顶部显示一个半透明的覆盖图。 这个覆盖包含箭头和注释,解释不同的button和旋钮做什么。

我认为这可以扩展到向用户显示上下文敏感的帮助。 如果这是不够的,你真的认为你需要一本手册,我会去一个伴侣网站。 这给了你完全的devise自由,允许你在不更新应用程序的情况下更新文档,允许维基风格的用户贡献的文档,并将启用额外的function,如延长应用程序的用户数据备份。 唯一的缺点是用户需要networking连接才能阅读手册。