目标是拥有一个在线文档系统,并具有以下主要要求:
- 将主要用作我们所有应用程序最终技术文档的中间阶段(尽管可能永远不会完成:)。通常按以下方式使用:有人遇到问题,我将其修复,并立即写下该修复程序。现在发生的事情变得无法控制:某人有问题,我解决了,我和某人都很高兴,但是两个月后,其他人也遇到了同样的问题,没有人记得修复的方法。
- 可从任何地方访问,在我们的apache服务器后面运行
- 用户/组管理,允许只读/读写/管理员访问
- 格式不是太重要:纯文本可以,但Wiki样式会更好
- 便宜或免费
我的一些想法:
- 只需在文件共享上或通过ssh提供文件即可(缺点:与Windows不太兼容,优点:简单,可以是任何文件类型)
- 将其保存在SCM中(如上svn / git,idem,但更易于访问和控制访问)
- Confluence:我们已经使用了Jira,Confluence是否值得?它如何与Jira集成?
- 还有什么吗
请不要对这些发表评论,或与其他系统分享您的经验。
文档是从代码(例如Javadocs)生成的,还是从头开始编写,作为用户指南,还是两者的某种组合?
—
FrustratedWithFormsDesigner
它主要是更多的用户指南,而不是代码文档(嗯,我们也有doxygen生成的,可能包括了它,但这并不是第一个关注点)
—
stijn 2011年
我将一些现金交给Spolsky。
—
工作