What is the recommended help file format to use in a modern Windows app?

大城市里の小女人 提交于 2019-12-05 01:30:47

Sandcastle - http://sandcastle.codeplex.com/ - is widely used. It has multiple output formats, including the generation of a website which you could publicly or privately host for your application users, allowing you to make updates as needed without needing to roll out new help files to all users individually.

You can also use Sandcastle to generate files which integrate with the MS help file viewer built into Windows. I don't know if this is "officially" the best method, but it works well.

The only caveat with Sandcastle is that it has a bit of a learning curve.

Also of interest: http://en.wikipedia.org/wiki/Microsoft_Assistance_Markup_Language. MAML defines a common schema for describing a very wide variety of help/documentation scenarios. MAML allows you to document end user functionality as well as API-level tasks. Depending on your audience, this may be of significant value. Sandcastle includes many MAML templates.

The recommended one is probably the Assistance Platform client (HelpPane.exe), with .h1s extensions which is default support by Vista and W7, and also in recent Office versions

Afaik h2s (and now html3) is only support by VS.

But since Asistance Platform is VIsta+, if you still need to support XP, you are stuck with CHM

易学教程内所有资源均来自网络或用户发布的内容,如有违反法律规定的内容欢迎反馈
该文章没有解决你所遇到的问题?点击提问,说说你的问题,让更多的人一起探讨吧!