我是一个名为Now.in的网站的创始人。一开始是我自己写的所有程序。我们要经营一家初创公司。很快就会有更多的人参与进来。一些技巧/概述只存在于我的脑海中,向新来者解释是需要时间的。因此,我想写一些文件供其他人阅读。问题来了,怎么写文件?我应该使用哪个工具/平台?
我有点担心。
当然,我可以用Google编写文档,运行Wiki,甚至可以直接使用BitBucket回购的wiki。但问题是,如果我想使用另一个文件系统而不是目前的文件系统呢?在标记语言/Google之间转换文档将是困难和昂贵的。
图表在文档中解释事物是很重要的。一些简单的wiki/doc系统不支持上传图像。您可以将图像上传到其他地方,并在文档中插入图像标记,使用起来有点不方便。
此外,似乎有些标记语言很难学习和记住。我不喜欢花一个月的时间学习一些看起来像LaTeX的东西,然后开始写一个文件,这会让我发疯。简单而有表现力的标记/所见即所得(WYSIWYG)会很好。
Google易于使用,功能也足够强大。但是,有时我想在文档中编写代码示例。语法突出显示是很好的。但是Google并不适合用户编写代码。
代码友好,这也是一个很好的功能。
集成
对于概览/SOP/诀窍文档,直接在文档系统中编写它们是很好的。但是对于我的Python代码库来说,可能有一些从这些代码中生成的API级别的文档。有两个文档系统是不方便的,一个用于API,另一个用于概述。所以,我觉得把它们整合在一起会很好。
也许我有一些更多的担忧在我的脑海中,但我想不起来了。我想知道你们使用的是哪种文件系统?你能推荐一些吗?即使使用这个平台/系统需要一些费用,我们也能负担得起,如果不太贵的话。
发布于 2011-07-31 11:20:26
关于您的要求:
[pydoc:Class/Method],然后映射到您的pydoc使用的任何URL。发布于 2011-07-31 12:12:36
我完全同意西蒙强调他的观点的观点。Trac是一个很好的工具,我曾多次使用它将项目的几乎所有方面都放在一个集中的位置上。然而,还有其他的工具。
您可以考虑的另一个工具是雷德明。对于您想要的一些特性(例如可移植性),您需要使用插件定制它。我对Redmine没有丰富的经验,因为我只使用过一次,但我认为它非常稳定和可靠,而且它确实在促进待办事项列表、文档、错误报告等方面完成了工作。
再一次,Redmine被构建成一个项目信息的一站式商店,从计划/任务跟踪一直到源代码和文档。这可能有点过分,但我喜欢拥有这样的工具供我使用。
发布于 2011-07-31 12:09:22
https://softwareengineering.stackexchange.com/questions/97369
复制相似问题