用于编写基于HTML的用户手册的最佳软件

Question

我正在开发一个项目,我需要为一个软件生成最终用户文档.在明年的某个时候,我正在编写本文档的软件将被淘汰.因此,我不想花很多时间在专业级手册上.这是一所大学的研究生和一些内部专业人士将会看到的东西.虽然如果它足够好又有用,我可以将它作为免费文档反馈给开源社区.

我认为HTML手册非常合适.该软件是用PHP编写的,所以无论谁使用它都会打开一个Web浏览器并准备就绪.这也导致我或其他人将手册页面集成到软件本身的可能性.

我对制作/使用这个软件的wiki不感兴趣.我真正需要的是一个软件,我可以像普通文档一样编写并生成简单的HTML.我知道有一些像Dreamweaver和Frontpage这样的软件,但我特别感兴趣的是一些旨在使文档创建过程更容易的东西(将屏幕上限和视频的过程与简单的图像/视频编辑集成在一起).

如果您认为另一种方法(HTML文档除外)可能会更好,我很乐意听到它.如果你有另一种方法,并且你认为你知道一个很好的软件解决方案来实现这一目标,请告诉我.

我对该方法的主要愿望和实现它的软件是

• 部署简单(HTML页面无需特殊设置.可以简单地部署帮助目录,其中包含所有手册页)
• 无需使用特殊软件(每个拥有Web浏览器的人都可以阅读HTML)
• 易于使用,我编写文档/小学习曲线(我不想花很多时间学习一个复杂的软件来处理一个相对较小的项目)
• 能够将文本,视频和图像组合成单个文档(HTML页面显然支持将所有这些组合在一起)

谢谢!

@Lie Ryan:"MediaWiki将所有文本和数据(内容页面,用户详细信息,系统消息等)存储在数据库中......"这是我想要避免的.我认为wiki非常棒且有用,但我只对提供非常低开销的静态数据感兴趣.

Answer 1

每当我被要求编写用户手册时(意味着每次我完成一个项目),我都喜欢使用Markdown.结合最小的CSS,它非常易于使用.

Markdown是一个面向网络编写者的文本到HTML转换工具.Markdown允许您使用易于阅读,易于编写的纯文本格式进行编写,然后将其转换为结构有效的XHTML(或HTML).

因此,"Markdown"是两件事:(1)纯文本格式化语法; (2)用Perl编写的软件工具,它将纯文本格式转换为HTML.