任何人都可以提供有关如何在编写api文档时管理开源软件开发人员社区的建议或指向任何指南吗？
大多数项目的一个典型的，非托管的起点是拥有一个项目维基，任何人都可以自由创建页面，向现有页面添加内容，编辑现有内容等。问题是，尽管人们有最好的意图，维基可以容易最终成为一个杂乱无章，写得不好，不完整，用不同的声音写成等等。
那么，如何提高文档质量呢？
我怀疑一个关键因素是明确的编辑/风格指南，类似于http://en.wikipedia.org/wiki/Wikipedia:Encyclopedic_style#Information_style_and_tone。任何人都可以指出专门针对软件apis量身定制的指南示例吗？
是否还有人发现有用的其他做法？例如。组建一个核心的编辑团队，并接受社区添加的大多数文档很可能需要“强烈编辑”？
答案 0 :(得分：1)
简短的回答是，解决方案是社会/人，而不是技术。获得任何项目的良好文档的方法是让某人有时间，负责为文档进行高级组织，然后参与开发和用户社区，以确保文档保持最新并继续解决用户通常遇到的问题和困惑。
社区项目已经接受了你需要点人（即“经理”，对于项目的各个方面，如“翻译”和“发布”，以及各种组件。同样的事情需要发生在文档中。
至于工具，Sphinx非常棒，虽然它不像“wiki那样”，但您可以使用您的项目所熟悉的任何版本控制系统来存储文档并配置您的Web服务器以在提交后重建文档/更新/推。对于我曾经合作过的任何项目，哪个就好了。