什么是收集业务规则文档的好方法？

Question

我遇到了一种情况，我敢肯定，我的业务规则文档分布在电子邮件，文档（现在已过期）和IM中。这很臭。

我可以想到两个选择：Sharepoint（讨厌它，搜索功能很糟糕）或wiki。

我希望在理想的解决方案中看到一些事情：

• 轻松更新：不要让我拉起来更新文档
• 差异视图：有时您只需要查看新内容
• 可订阅：逐页通知新变更
• 基于角色：编辑和查看网页可与角色相关联
• 附件：轻松收录模型，文件等。
• 搜索：这是一个谷歌后世界，我希望能够立即搜索和查找 - 除非我们使用的配置不正确，否则Sharepoint会丢失此类别
• 附件限制：理想情况下，该解决方案不允许上传我们称之为文档的一堆Word文档。我希望文档具有一致（简单）的格式。以PDF，txt等方式强制执行附件。

跟进我的维基评论看起来有at least 3 wikis可以做我想做的事（奖励，SharePoint-Wiki-Plus，ThoughtFarmer）。 ThoughtFarmer，爱这个名字。

Answer 1

+10⁶对于Wiki来说，这是迄今为止我发现的文档，特别是技术文档的最佳解决方案。 IMO，VCS中“好”Wiki引擎优于Office文档的优点是（但您已经意识到这一点，因为此功能列表非常接近您的要求）：

• 它们比VCS中的Office文档更快更容易使用（无需打开VCS客户端，签出最新版本，可选择锁定它，打开单词，保存，签入，释放锁）
• 它们是基于文本的，所以你制作差异（不像单词），这只是一个必须
• 他们提供通知机制（例如邮件，RSS），因此信息被推送给您（不像VCS，当您需要在文档过期时提取文档）
• 没有“文档因其他用户问题而被锁定”，因为有人忘记发布它（如果您使用的是独占锁，通常就是您无法合并的文档）
• 页面可以轻松地重构，重新组织，组装在更大的文档中
• 他们真的很合作
• 它们为代码提供了更好的支持（例如，您可以直接指向VCS中的源代码，格式要比单词更好）
• 他们可以索引页面和附加文档的内容（pdf，办公室文档等）并使其可搜索

我在使用Wiki进行文档处理时遇到的唯一问题是，在您的代码的同时对文档进行版本更难（即您提供版本x.y.z并希望“锁定”此版本的文档）。我用出口来解决这个问题，但这并不完美。

我已经使用 TWiki Foswiki，Confluence和XWiki。它们都是“好的”Wiki引擎（如上所定义）并且都符合您的要求。因此，最终的选择可能仅取决于您的约束（许可，定价，技术）和个人偏好。

截至今天，如果商业工具是一个选项，我会选择Confluence，如果不是，则选择XWiki。

Answer 2

更为离谱的想法是研究FitNesse。它是一个wiki，主要用于描述业务规则（或验收要求）作为测试。

Answer 3

我正在开发一个。

大约一年前，我在网上寻找需求管理软件，发现其中至少30个，大约有3个类别：

• 无价（（例如在航空航天公司销售）

• 昂贵（例如每个座位1000美元），我的雇主从未选择使用

• 廉价或免费，但遗漏的功能在我看来很重要

还有一些通用工具（例如Wiki，或电子邮件和Word文档和/或电子表格），这些工具也缺少我认为很重要的功能。

---

  

我认为你应该详细说明：“缺少看起来很重要的功能”。

您可以使用通用Wiki做的事情：

• 创建功能列表
• 描述每个功能（可能是每个功能的单独页面/部分）
• 协同执行此操作（版本控制，更新通知，讨论页面）

但是，有些事情我认为你不能用通用的Wiki，甚至是非常基本的东西：

• 定义自定义属性（例如“开始日期”，“预计费用”等）;将这些属性值与您的功能相关联;列出具有属性的特征（在表格或网格中）（以便对它们进行排序，例如按“重要性”或“难度”排序）

• 帮助追溯（当只有两个阶段，例如“要求”和“实施”时，可追溯性并不太难;但是当有几个阶段时，例如“用例”，“功能规范”，则更难， “架构”，“实施细节”，“测试用例”，“测试结果”和“错误报告”）

• 支持结构化信息，即小节而不仅仅是顶级部分。

即使简单的编辑也不应该是一个不错的选择。商务人士可能更喜欢使用MS Word UI进行编辑：但MS Word会生成文档，即“信息孤岛”;但如果你不使用MS Word，那么你正在使用什么？ WYSIWYG浏览器内编辑器？或降价语法？

Answer 4

我喜欢使用FogBugz内置的Wiki功能，假设您已经将它用于功能/错误跟踪。将信息放在同一个工具中很方便。

Answer 5

Drupal符合您列出的要求，它可以通过大量模块进行高度扩展（请参阅下面的内容），并且可以在GPL下使用。

• Wysiwig editor
• Diff view
• Subscriptions
• User access management
• Attachment management
• Can be configured with Wiki functionality

Answer 6

我们在之前的项目中使用了JIRA来存储大约750种不同的业务规则。 JIRA主要是/有点像一个错误跟踪工具，但它是如此强大和可定制，你可以将它用于各种工作流程/过程/知识库情况。 （顺便说一句 - 我不会为生产它的公司工作）。

• 易于更新：是
• 差异视图：可以使用完整的更改历史记录
• 可订阅：是的，有“观察名单”的想法
• 基于角色：是的，功能丰富的安全模型
• 附件：是的，每条规则都可以拥有自己的附件
• 搜索：是，可以使用全文搜索
• 附件限制：嗯 - 不确定这个和你正在尝试做什么。

如果您决定沿着这条路走下去，可以提供一些建议......

• 在其他地方使用JIRA的可自定义ID来引用规则，例如MYPRJ-334
• 明确指出您计划使用的任何州的意思，建议，批准，已实施，已验证，已删除。
• 规则的唯一定义是在说明中 - 所有评论只是评论
• 您可以将规则链接到用例，组件

这是一个很好的方法，我真的推荐它。