用于协作手动编写的软件

时间:2011-03-01 08:40:04

标签: documentation wiki documentation-generation manual

我试图找到一个软件来帮助一个小型(~3-5人)团队编写A)用户指南和B)软件可扩展部分的API参考。我们非常喜欢使用某种形式的wiki,但有一些特定的要求:

  • 将手册导出为在线和离线可读形式的能力(例如,可以放在Web服务器上或本地读取的一堆HTML文件) < / p>

  • 从XML文档自动创建页面。我们正在用VB.Net/C#.Net编写,大多数API特定的东西已经有XML文档注释。如果手册的API部分可以指定类,方法,参数等,那么这将是很好的,但也允许编写者从其他人链接到这些页面。 (例如,有一个详细介绍foo类的页面,并且能够拥有一个页面,详细说明如何使用到foo.increaseBarCount()方法的页面的API链接执行一些常规任务)

除了显而易见的(“易于使用”,“为我做所有的写作,以便我能摆脱编写技术文档的繁琐”,“不会导致全球热核战争”)之外,这就是它的关键所在。

这样的软件是否存在?可以使用mediawiki扩展将类似的系统拼凑在一起吗?

2 个答案:

答案 0 :(得分:1)

至于“从XML文档中自动创建页面”,显而易见的解决方案将由doxygen完成。它从源代码中嵌入的特殊文档注释创建文档(HTML,PDF,WinHelp ...)。它处理Javadoc注释,Qt样式注释和XML注释。如果生成HTML,页面名称是可预测的,因此很容易链接到; doxygen还可以自动创建内部链接。如果你使用其他格式,你可能会嵌入某种锚来引用页面名称,但我不太确定。

关于一般文档,我们在使用wiki方面有很好的经验。我们使用MediaWiki(维基百科成名),但任何体面的维基都可能会这样做。 我们从来没有尝试过打印它,但谷歌从MediaWiki上展示了各种打印解决方案,所以你可以在没有太多麻烦的情况下完成一些工作。

我们喜欢使用wiki作为文档的主要内容是,当您发现错误时,您可以轻松地更改它们;让他们保持新鲜感。此外,不用担心有过时的副本。

答案 1 :(得分:0)

你可以查看Atlassian Confluence。我相信他们有一个免费版本(可能只是一个报价,所以你可能最终支付长期支付,不知道)为小团队。它们也有一个API,因此编写一个实用程序来提取XML C#文档并使用API​​从中创建页面(如果不存在任何内容)并不困难。 维基易于使用,开源项目使用相当多。你可以看看 例如,ANTLR Documentation,即Confluence。