Warning: file_get_contents(/data/phpspider/zhask/data//catemap/6/haskell/9.json): failed to open stream: No such file or directory in /data/phpspider/zhask/libs/function.php on line 167

Warning: Invalid argument supplied for foreach() in /data/phpspider/zhask/libs/tag.function.php on line 1116

Notice: Undefined index: in /data/phpspider/zhask/libs/function.php on line 180

Warning: array_chunk() expects parameter 1 to be array, null given in /data/phpspider/zhask/libs/function.php on line 181
Java web应用程序的交互式手册示例_Java_Php_Asp.net_Ruby On Rails_Manual - Fatal编程技术网

Java web应用程序的交互式手册示例

Java web应用程序的交互式手册示例,java,php,asp.net,ruby-on-rails,manual,Java,Php,Asp.net,Ruby On Rails,Manual,我需要为我的web应用程序编写帮助(例如显示某些按钮的功能说明)。有这样做的好例子吗?可以用来提取java代码文件中包含的所有注释请查看java帮助。模拟旧版Windows中的帮助系统在Wiki中编写文档非常现代。它易于编辑、易于构建等。 但我讨厌它。我真的很讨厌它。它的结构从来都不好,也不容易阅读。为了让维基变得更好,你需要付出很多努力 所以我建议使用一个简单的CMS。没有滥杀滥杀,只是文本编辑与链接。您可以选择将其集成到您的Web应用程序中,并且可以从中提取PDF。 这对于为打印等提供脱机帮

我需要为我的web应用程序编写帮助(例如显示某些按钮的功能说明)。有这样做的好例子吗?

可以用来提取java代码文件中包含的所有注释

请查看java帮助。模拟旧版Windows中的帮助系统

在Wiki中编写文档非常现代。它易于编辑、易于构建等。
但我讨厌它。我真的很讨厌它。它的结构从来都不好,也不容易阅读。为了让维基变得更好,你需要付出很多努力

所以我建议使用一个简单的CMS。没有滥杀滥杀,只是文本编辑与链接。您可以选择将其集成到您的Web应用程序中,并且可以从中提取PDF。

这对于为打印等提供脱机帮助来说是很好的。我只需要使用好的旧HTML/CSS-这将保持用户在浏览器中已经知道的行为,并且您应该已经拥有应用程序的样式表,因此您可以通过帮助页面维护L&F,而无需额外的努力

看看谷歌地图上的帮助()——了解布局想法等


当我查看Google帮助页面时,我注意到了一件事,那就是搜索(这并不奇怪),这可能有点棘手——如果你的站点是面向外部的,那么我会使用“site:”关键字实现这一点,并使用Google搜索。如果你的网站是内部的,你必须进行自己的搜索,但这应该不会太难,而且可能会是一个非常有趣的子项目。

如果你使用的是PHP,请查看

phpDocumentor工具是一个独立的工具 类似于JavaDoc的自动文档管理器 用PHP编写


如果您想制作一本用户手册,说明每个按钮的功能,我发现使用Adobe Captivate之类的工具记录屏幕交互,然后将其转换为Flash电影或PDF格式非常有用。

专门针对Rails: 是一个很好的小型CMS工具,可以用于嵌入式帮助系统


否则,它可以很好地作为托管解决方案使用。

我发现构建引擎Hudson中的帮助非常优雅和独立

你有一个帮助图标,你点击它,帮助文本在页面内联显示,你再次点击它就会消失


试着出发去吧tohttp://localhost:8080/configure 然后单击右侧的许多(?)按钮。

im正在寻找功能帮助,告诉用户web应用程序中的按钮的功能。javadoc太技术化了。thx,但我想将其与web应用程序集成,然后您需要描述如何将其与web应用程序集成。你现在的描述很模糊。Eclipse帮助系统也是一个选项。您的应用程序使用什么编程语言?”因为这个问题有太多的标签…任何,因为它看起来根本没有解决方案。