你如何协作编写规范？

Question

我正在与一个地理位置分散的开发团队（另外2人）合作，我正在寻找合作规范的好方法......我们认为我们可能会使用Google Docs编写规范，所以我们都可以访问在中心位置修改它。

你做了什么？你有什么好主意？

Answer 1

Google Wave - 正是它的意思 - 合作

Answer 2

IMHO，文字处理程序是程序员的错误工具。规范应该用纯文本编辑器编写，并使用lightweight markup，如reStructuredText，AsciiDoc等。

这种方法的好处是：

• 有很好的管理纯文本的工具，已经掌握在程序员手中（VCS，自动构建系统，差异，补丁，编程编辑器，grep等）。
• 标记语言允许表达意图而不是格式化。

考虑到这一点，Wiki似乎是明显的选择。

我个人选择的工具链是：

• reStructuredText作为标记语言。
• Trac作为Wiki
• Firefox + it's all text extension
• Emacs + rst-mode

Answer 3

如果您有Intranet或VPN，我实际上会考虑为这些规范安装和使用小型Wiki。

与Google文档相比，您获得了：

1. 更好的版本控制和更改跟踪（恕我直言）
2. 更容易为小节开始新文件
3. 实际的标记而不是WYSIWYG（关于品味，我更喜欢LaTeX和Word）。
4. 可以附加各种其他文件类型
5. 非常容易备份
6. 非常容易创建离线版
7. 您不必担心将敏感材料存放在其他地方。

缺点是它不是WYSIWYG，这对您来说可能是也可能不是问题。

当然，您可以选择支持更好编辑器的Wiki实现，甚至可以选择同步协作。

Answer 4

技术的选择是一个问题，谷歌文档是一个不错的选择恕我直言。但真正的挑战是如何管理流程，例如划分任务。

我的建议是首先确保平台和所有相关技术尽可能最好地确定。然后，撰写一份完整的目录。精心设计的TOC将允许您正确划分任务，而不是“分步”彼此的工作。从那时起，你们每个人都“分配”你们指定的部分，并审查彼此的工作。

实际上，每个TOC子部分都成为一个原子工作单位，可由一个对所述部分负责的个人分配和维护。

祝你好运！

Answer 5

我认为这取决于

1. 编写规范的重要程度
2. 如果您可能同时写作
3. 您是否打算发布规范。

Google Docs很容易上手。您现在可以一次导出所有文件夹也很棒。不过，对于即将发布到网络上的内容，维基或通用cms是更好的展示工具。维基也将与您现有的网站集成。

如果您的规格很小，主要是由一个人编写，那么请使用您托管项目代码或网站的任何工具。如果您不可能同时进行编辑，那么维基是好的。

我已经完成了wiki的事情，传递的文档内容和Google Docs的事情。

• 维基的东西起动力很小，持续时间很长。在一定的尺寸下，它确实会变得很痛苦。
• 传递的文档内容（写入，发送电子邮件，编辑，发送电子邮件等）仅适用于一个人启动所有内容的情况。只要有轻微的编辑，那就太糟糕了。
• 在您拥有多个文档和多个编辑或希望在线发布之前，Google文档是可以的。

HTH

Answer 6

这与编程无关，但我个人使用Google文档编写共享文档，并发现它易于使用。

如果Google服务器暂时停机或互联网连接不可用，我建议启用Google Gears。

Answer 7

为了协作编写规范，您可以尝试Gingko。

这是一个卡片树编辑器，这意味着它是索引卡和大纲之间的混合，具有实时协作和完整的Markdown支持（以及基本的LaTeX）。

我们仍然缺少一些功能（版本历史记录，评论等），但对于某些人来说，在树形结构中拥有所有东西的好处都超过了这些缺点。

使用它编写规范非常棒，因为您可以为每个用户故事创建一张卡片，并根据需要随意钻取（如果您愿意，可以将它们组织成类别）。

http://gingkoapp.com