您的团队使用哪些工具来撰写用户手册

您的团队使用哪些工具来撰写用户手册

本文介绍了您的团队使用哪些工具来撰写用户手册?的处理方法,对大家解决问题具有一定的参考价值,需要的朋友们下面随着小编来一起学习吧!

问题描述

基本请求是:


  • 可读/文本格式(易于版本控制)

  • 在线(用于协作)

  • 简单格式化(markdown ok,html太多)

  • 严格格式化(所以作者不会发明新的类型标题,
    子弹等)

  • 可导出为PDF,HTML

  • 易于备份和部署(所以我们可以部署客户网站为
    只读版本)

  • human readable / text format (for easy version control)
  • online (for collaboration)
  • easy formatting (markdown ok, html is too much)
  • strict formatting (so authors don't invent new types of titles,bullets etc.)
  • exportable to PDF, HTML
  • easy backup and deployment (so we can "deploy" to customers site asread only version)

我们正在考虑使用某种维基引擎,但需要使用文件进行存储或有其他方式部署给客户,并易于安装/维护。另外,它必须是免费的/便宜的(汇合太贵了)

We are thinking about using some kind of wiki engine, but it would need to use files for storage or have other means of "deployment" to customer and be easy to install/maintan. Also, it would have to be free / cheap (confluence is way too expensive)

任何建议?

编辑:我不是在寻找工具来记录代码,我们使用的是Sandcastle。

I'm not looking for tools to document code, we have that covered using Sandcastle.

推荐答案

尽管可能无法回答您的所有请求,可能值得一看。

Although it may not answer all your requests, DokuWiki may be worth taking a look at.

与其他维基一样,它有一个,并具有生成,以及功能,可以方便的帮助系统。

As with other wikis, it has a simple syntax, and has version control to track revisions, generates table of contents, and a full-text search feature which can come handy for a help system.

您可以想评估,看看是否符合您的需求。

You may want to evaluate the feature list to see if it will meet your needs.

此外,似乎也有一个很好的。虽然我没有使用DokuWiki或其插件,似乎有可用的 PDF导出以及

Also, there seems to also be a good collection of avaialble plugins. Although I haven't used DokuWiki or its plugins, there seems to be plugins available for PDF export as well.

这篇关于您的团队使用哪些工具来撰写用户手册?的文章就介绍到这了,希望我们推荐的答案对大家有所帮助,也希望大家多多支持!

08-27 09:02