有关开源项目的文档建议？ [英] Recommendations for Documentation with an Open Source Project?

问题描述

我们正在考虑记录一个刚刚起步的开源项目，我希望有一些关于好的建议方法和/或工具，为您效果良好。此外，作为开发人员，您更喜欢在线文档，基于wiki的文档，帮助文件还是其他？

We are looking at documenting a fledgling open source project, and I was hoping for some suggestions on good methods and or tools that worked well for you. Further, as a developer, do you prefer online docs, wiki based docs, help files, or some other?

推荐答案

您的应用程序正在C＃中开发，请查看生成API文档的 Doxygen 。它是非常强大的（它执行标准的javadoc样式成员文档，但也会生成调用，继承，文件依赖关系和协作图）。尽管它的力量很容易使用。它可以生成无数格式的API文档：HTML，Latex，联机帮助页等。

Seeing as your application is being developed in C#, have a look at Doxygen for generating your API documentation. It is extremely powerful (it does the standard javadoc style member documentation, but will also generate call, inheritance, file dependency and collaboration graphs). Despite its power it's easy to use. It can generate API docs in myriad formats: HTML, Latex, manpage, etc.

对于编写手册，教程和其他更灵活的文档类型，请认真考虑设置一个维基。我已经使用 DokuWiki 获得了巨大的成功。它支持语法高亮，因此它对代码项目有好处。它还具有用于开源项目的用户ACL。它也只需要PHP和没有数据库。当然，它提供了标准的wiki功能，如版本控制。

For writing manuals, tutorials, and other more flexible types of documentation, seriously consider setting up a wiki. I've used DokuWiki with a great deal of success. It's got support for syntax highlighting, so it's good for code projects. It also has user ACLs which will be handy for an open source project. It also requires only PHP and no database. Of course it offers the standard wiki features like versioning.

最后，我应该提到 trac ，这是一个wiki，版本控制，bug跟踪器混合。这绝对值得一看。

Lastly, I should mention trac, which is a wiki, version control, bug tracker hybrid. It's definitely worth a look.

这篇关于有关开源项目的文档建议？的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！