代码之家  ›  专栏  ›  技术社区  ›  Jazzepi

用于编写基于HTML的用户手册的最佳软件[关闭]

  •  6
  • Jazzepi  · 技术社区  · 14 年前

    我在做一个项目,需要为一个软件生成最终用户文档。在明年的某个时候,我正在编写此文档的软件将退役。因此,我不想花太多时间在专业级手册上。一所大学的研究生和一些内部专业人士将会看到这一点。不过,如果它足够好和有用,我可能会把它作为免费文档反馈给开源社区。

    我对为这个软件制作/使用wiki不感兴趣。我真正要找的是一个软件,我可以像一个正常的文件编写和生成简单的HTML。我知道有些软件像Dreamweaver和Frontpage,但我特别感兴趣的是一些旨在使文档创建过程更容易的软件(在这种软件中,拍摄屏幕帽和视频的过程与简单的图像/视频编辑集成在一起)。

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

    • 简单的部署(HTML页面不需要特殊设置)。帮助目录可以简单地与所有手册页一起部署)
    • 无需使用特殊软件(每个拥有web浏览器的人都可以阅读HTML)
    • 易用性对我来说是写文档/小的学习曲线(我不想花很多时间学习一个复杂的软件来完成一个相对较小的项目)

    谢谢!

    @LieRyan:“MediaWiki将所有文本和数据(内容页、用户详细信息、系统消息等)存储在数据库中……”这是我想要避免的。我认为wiki很棒,也很有用,但我只对以非常低的开销提供静态数据感兴趣。

    4 回复  |  直到 14 年前
        1
  •  7
  •   Shaun Mason    14 年前

    每当我被要求写用户手册(意味着每次我完成一个项目),我喜欢使用 Markdown . 再加上最少的CSS,它非常容易使用。

    网络写手的工具。降价允许 你要用一个简单易读的, 很容易写纯文本格式,那么 (或HTML)。

    纯文本格式语法;和(2) 一种用Perl编写的软件工具 将纯文本格式转换为

        2
  •  2
  •   elo80ka    14 年前

    我想这不完全符合你的要求,但我是你的超级粉丝 Sphinx ReST ,您可以很容易地生成HTML和PDF版本。HTML生成使用模板,所以它是非常可定制的。另外,对于我们这些喜欢这样的东西的人来说,有纯文本版本也有额外的好处(ReST有点可读性:)

        3
  •  1
  •   Incognito    14 年前

    用XML编写手册,使用 docbook . 这将允许您对内容执行任何需要的操作,然后以自己的方式生成演示文稿。

    有很多 tutorials 从docbook到HTML工具。

    OO can save in docbook .

        4
  •  0
  •   Reinderien    14 年前

    推荐文章