您会推荐什么样的在线技术文档系统?[关闭]


11

目标是拥有一个在线文档系统,并具有以下主要要求:

  • 将主要用作我们所有应用程序最终技术文档的中间阶段(尽管可能永远不会完成:)。通常按以下方式使用:有人遇到问题,我将其修复,并立即写下该修复程序。现在发生的事情变得无法控制:某人有问题,我解决了,我和某人都很高兴,但是两个月后,其他人也遇到了同样的问题,没有人记得修复的方法。
  • 可从任何地方访问,在我们的apache服务器后面运行
  • 用户/组管理,允许只读/读写/管理员访问
  • 格式不是太重要:纯文本可以,但Wiki样式会更好
  • 便宜或免费

我的一些想法:

  • 只需在文件共享上或通过ssh提供文件即可(缺点:与Windows不太兼容,优点:简单,可以是任何文件类型)
  • 将其保存在SCM中(如上svn / git,idem,但更易于访问和控制访问)
  • Confluence:我们已经使用了Jira,Confluence是否值得?它如何与Jira集成?
  • 还有什么吗

请不要对这些发表评论,或与其他系统分享您的经验。


文档是从代码(例如Javadocs)生成的,还是从头开始编写,作为用户指南,还是两者的某种组合?
FrustratedWithFormsDesigner

它主要是更多的用户指南,而不是代码文档(嗯,我们也有doxygen生成的,可能包括了它,但这并不是第一个关注点)
stijn 2011年

我将一些现金交给Spolsky。
工作

Answers:


11

我打算建议一个维基

因为Confluence是一个Wiki,所以我认为将其与JIRA一起使用是一个好主意。您将具有可以直接绑定到JIRA问题的优势,因此可以直接进行实际的代码/文档/所做的任何更改等。

这样的任何代码文档存储库的关键是导航方面。您不希望页面断开连接,难以查找等。请像在网站上那样,将“网站布局”考虑在内。


合流显然可以以各种平面格式导出。像最简单的方法一个声音从很容易地编辑到成品produc.t让

2
我在Confluence工作,从MediaWiki迁移而来,并且可以很好地输出多种格式(Word是最受欢迎的格式)。但请注意,其所见即所得的编辑工具存在令人难以置信的错误,并且标记系统至少在我们的安装上仍有很多不足之处。
菲利普·里根

对于Wiki +1,我也发现Trac在这种情况下非常有用,因为它与SVN集成在一起,也允许文件共享。

我们检查了Confluence试用版,这将是解决方案。似乎可以做的事情比我们需要的更多,但是使用起来很容易。几年前,我尝试过Trac,这对我来说有点太混乱了,尤其是在插件等方面
。– stijn 2011年
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.