什么是收集业务规则文档的好解决方案？ [关闭]答案

【问题标题】：What's a good solution for collecting business rule documentation? [closed]什么是收集业务规则文档的好解决方案？ [关闭]
【发布时间】：2009-09-15 22:22:46
【问题描述】：

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

我可以想到 2 个替代方案：Sharepoint（讨厌它，搜索功能很糟糕）或 wiki。

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

易于更新：不要让我打开 Word 来更新文档
差异视图：有时您只需要查看新功能
可订阅：逐页通知新更改
基于角色：页面的编辑和查看可以绑定到角色
附件：轻松包含模型、文件等。
搜索：这是一个post google world，我希望能够立即搜索和找到——Sharepoint 在这个类别中输了，除非我们使用的那个配置不正确
附件限制：理想情况下，该解决方案不允许上传一堆我们称为文档的 Word 文档。我希望文档具有一致（且简单）的格式。强制附件为 PDF、txt 等。

跟进我的 wiki 评论，似乎有 at least 3 wikis 在做我想做的事（激励、SharePoint-Wiki-Plus、ThoughtFarmer）。 ThoughtFarmer，喜欢这个名字。

【问题讨论】：

+1 - 一个很好的问题。如此常见的问题 - 我会非常感兴趣地关注这些答案。
谢谢！当我搜索它并没有找到它时感到惊讶。
@jcollum 这是因为程序员尽可能避免需求文档：P
@Robert：我只希望我的分析师将资料保存在一个地方！
我同意上传 .doc 文件是一个非常糟糕的主意，但这看起来更像是一项政策而不是一项功能。

标签： documentation wiki business-logic

【解决方案1】：

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

它们只是比 VCS 中的 Office 文档更快、更容易使用（无需打开 VCS 客户端、签出最新版本、可选择锁定、打开 word、保存、签入、解除锁定）李>
它们是基于文本的，因此您可以创建差异（与 word 不同），这是必须具备的
它们提供通知机制（例如邮件、RSS），因此信息会推送给您（与 VCS 不同，您需要在文档过期时提取文档）
没有“文档被其他用户锁定问题”，因为有人忘记释放它（如果您使用排他锁，这在您无法合并的文档上经常出现）
页面可以轻松重构、重组、组装成更大的文档
他们真的很合作
它们为代码提供了更好的支持（例如，您可以直接指向 VCS 中的源代码，其格式比 Word 中的要好得多）
他们可以为页面和附加文档（pdf、office docs 等）的内容编制索引并使其可搜索

我在使用 Wiki 获取文档时遇到的唯一问题是，很难同时对文档进行版本化和代码版本化（即，您交付版本 x.y.z 并希望“锁定”该版本的文档）。我已经使用导出来解决这个问题，但它并不完美。

我已经与 ~~TWiki~~ Foswiki、Confluence 和 XWiki 合作过。它们都是“好”的 Wiki 引擎（如上定义）并且都满足您的要求。因此，最终选择可能仅取决于您的限制条件（许可、定价、技术）和个人偏好。

从今天开始，如果可以选择商业工具，我会选择 Confluence，如果不是，我会选择 XWiki。

【讨论】：

Confluence 看起来不错。 “在 Word 中编辑”功能可能会得到 BA 的分数，但它会让我发疯。过多的格式只会使内容更难阅读。
Confluence 的 wiki 标记基于 Textile (textism.com/tools/textile)，非常好。我非常喜欢它，我通常使用 wiki 标记直接编辑我的 wiki 页面（即，不是 WYSIWYG 编辑器，也不是 Word）。但其他选项使其对新用户和/或非技术人员非常友好。
这可能是答案，但我会再等一周左右
非常感谢您的反馈！

【解决方案2】：

一个更离奇的想法是查看FitNesse。它是一个 wiki，主要旨在将业务规则（或验收要求）描述为测试。

【讨论】：

+1，很有趣。通过阅读他们的网页，不知道它是否可以在 C# 环境中工作，但也不知道它不会。
FitNesse 是一个编写“可执行规范”的工具，但它不是很“BA 友好”。顺便说一句，对于 Web 开发，我更喜欢 StoryTestIQ (STIQ)，它是 FitNesse 和 Selenium 的一种混合体。
该领域的另一位新玩家是storyteller.tigris.org

【解决方案3】：

我正在开发一个。

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

无价（例如在航空航天公司销售）
昂贵（例如每个座位 1000 美元），我的雇主从未选择使用它
便宜或免费，但缺少我认为重要的功能

还有通用工具（例如 Wiki，或电子邮件和 Word 文档和/或电子表格），它们也缺少在我看来很重要的功能。

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

您可以使用通用 Wiki 做一些事情：

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

但是，我认为有些事情是通用 Wiki 无法做到的，甚至是非常基本的事情：

定义自定义属性（例如“开始日期”、“估计成本”等）；将这些属性值与您的功能相关联；列出特征（在表格或网格中）及其属性（以便对它们进行排序，例如按“重要性”或“难度”排序）
帮助追溯（只有两个阶段时，追溯并不太难，例如“需求”和“实施”；但是当有多个阶段时，例如“用例”、“功能规范”、 “架构”、“实现细节”、“测试用例”、“测试结果”和“错误报告”）
支持结构化信息，即子部分，而不仅仅是顶级部分。

即使是简单的编辑也不是应有的好。商务人士可能更喜欢使用 MS Word UI 进行编辑：但 MS Word 会生成文档，即“信息孤岛”；但是如果您不使用 MS Word，那么您使用的是什么？所见即所得的浏览器内编辑器？还是markdown语法？

【讨论】：

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

【解决方案4】：

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

【讨论】：

不知道这个，谢谢。

【解决方案5】：

Drupal 满足您列出的要求，它可以通过大量模块进行高度扩展（见下文），并且在 GPL 下可用。

【讨论】：

我添加了新要求。如果没有扩展，Drupal 似乎无法满足我的“搜索”要求。我会说它符合搜索要求。

【解决方案6】：

我们在之前的项目中使用 JIRA 来存储大约 750 条不同的业务规则。 JIRA 主要/有点像错误跟踪工具，但它功能强大且可自定义，您可以将其用于各种工作流/流程/知识库情况。 （顺便说一句 - 我不为生产它的公司工作）。

易于更新：是的
差异视图：提供完整的更改历史记录
可订阅：是的，有“观察名单”的概念
基于角色：是的，功能丰富的安全模型
附件：是的，每个规则都可以有自己的附件
搜索：是的，提供全文搜索
附件限制：嗯 - 不确定这个以及您要做什么。

如果你决定走这条路，一些提示......

在其他地方使用 JIRA 的可自定义 ID 来引用规则，例如MYPRJ-334
对您计划使用的任何状态的含义有明确的指导方针，建议、批准、实施、验证、放弃。
规则的唯一定义在描述中 - 所有 cmets 都只是 cmets
您可以将 Rule 链接到用例、组件等

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

【讨论】：

感谢您的回答。附件限制是阻止人们上传 word 文档然后说“哦，嗨，我的业务规则在那边的 word doc 中，去阅读吧”。