OpenDocs 管道是什么?
OpenDocs 管道是 Visual Paradigm Desktop 图表与 OpenDocs 之间的连接
文档。它允许将图表作为管道工件发布,并在项目过程中进行跟踪
修订版,并在需要时插入到文档中。
此工作流适用于软件规格说明书、系统设计文档、业务
需求、架构文档、项目提案以及其他包含 Visual Paradigm 图表的交付物
包含 Visual Paradigm 图表。
图表修订工作流如何运作
图表不会自动添加到 OpenDocs 管道。您必须手动发送
图表到管道至少一次。首次发送后,未来的项目提交
将自动为该图表生成新的修订版。
- 在 Visual Paradigm Desktop 中打开图表。
- 打开图表右侧的抽屉面板。
- 点击发送到 OpenDocs 管道.
- 可选地输入注释以描述更改内容。
- 点击确定将图表发送到管道。
- 提交后续的项目更改以自动生成新的图表修订版。
可选的注释可以帮助团队成员了解为何发送该图表,或修订版之间发生了哪些更改
。例如,您可以记录用例图已更新以
反映新的身份验证流程。
基于桌面和基于在线的图表修订版
修订版的可用性取决于图表的管理位置。
在 Visual Paradigm Desktop 中创建的图表
一旦基于桌面的图表已发送到管道一次,每次项目提交
都会创建一个新修订版。这使得可以选择较早或较新的版本
在维护文档时。
基于在线的图表
对于基于在线的图表,OpenDocs 会显示最新版本以及任何已发送的修订版本
这些是手动发送的。这提供了对当前版本的访问,同时保留了
为文档目的而选定的修订版本。
如何打开 OpenDocs
- 在 Visual Paradigm 中,打开工具菜单。
- 选择应用.
- 启动OpenDocs.
打开 OpenDocs 后,您可以创建或编辑文档,并从
管道中插入图表。
如何将图表插入 OpenDocs 文档
- 在 OpenDocs 中打开文档。
- 将光标放置在您希望图表出现的位置。
- 点击插入.
- 选择管道.
- 点击所需的工件以插入其当前或最新版本。
如果您需要插入特定版本而不是最新版本,请点击
与该工件关联的修订版本图标。然后您可以查看可用的修订版本并
选择文档所需的版本。
如何选择特定的图表修订版
OpenDocs 允许您选择最符合您文档内容和目的的修订版
文档。当文档描述特定的项目里程碑时,这尤其有用,
发布版本或设计基线。
- 打开文档的流水线面板。
- 定位图表工件。
- 点击修订版图标。
- 查看可用的修订版。
- 选择您希望在文档中插入或使用的修订版。
选择特定修订版有助于防止文档无意中显示
反映文档批准后所做更改的图表。
如何更新文档中已使用的图表
OpenDocs 流水线面板显示项目可用的工件以及
当前与文档关联的工件。当文档中使用的图表被更新时,会
在面板中出现指示器。
- 打开文档的流水线面板。
- 找到带有更新指示器的工件。
- 点击指示器以查看可用的修订版。
- 将可用的修订版与当前正在使用的修订版进行比较。
- 选择首选修订版以更新文档。
您可以根据文档是否需要反映最新的项目更改,选择最新修订版或其他可用修订版,
或者是否应与特定
基线保持一致。
使用 OpenDocs 流水线的好处
- 文档一致性: 保持图表和书面内容与
项目更改保持一致。
- 修订版控制: 选择属于特定
文档或项目里程碑的图表版本。
- 高效更新:通过视觉指示器识别已更改的工件
在流水线面板中。
- 更好的协作:使项目团队、分析师、
开发人员和利益相关者能够使用相同的图表版本进行协作。
- 减少人工操作:避免反复导出和替换图表
当项目修订版可通过流水线获取时。
团队推荐工作流程
- 在将图表发送至 OpenDocs 流水线之前,先完成其初始版本。
- 发送图表时添加有意义的注释,特别是在记录重大
设计变更时。
- 定期提交项目更改,以便记录新的图表修订版。
- 将合适的图表修订版插入到 OpenDocs 文档中。
- 在发布或批准文档之前,请检查流水线面板。
- 查看更新指示器,并决定文档是否应使用最新修订版
还是特定的早期修订版。
可用性与要求
OpenDocs 流水线功能在专业版或更高版本中提供.
当仓库和项目均托管在 Visual Paradigm Online 上时,该功能即可使用。
在使用该工作流程之前,请确认您的 Visual Paradigm 版本支持此功能,并且
相关仓库和项目符合托管要求。
常见问题
所有 Visual Paradigm 桌面版图表是否会自动添加到流水线中?
否。图表必须至少手动发送一次到 OpenDocs 流水线。此后
初始操作完成后,项目提交可为该图表生成新的修订版。
将图表发送到流水线后会发生什么?
该图表将作为流水线工件提供。未来的项目提交将生成新的
修订版本,允许您在 OpenDocs 中插入或更新该图表。
我能否将较早的图表修订版本插入到文档中?
可以。打开流水线面板,点击工件的修订版本图标,然后选择所需的修订版本
以用于该文档。
我如何知道文档中的图表何时已更改?
当文档中使用的工件有新的可用修订版本时,OpenDocs 流水线面板中会出现更新指示器。
我可以选择是否使用最新修订版本吗?
可以。您可以插入当前或最新修订版本,也可以从可用修订版本列表中选择一个特定修订版本。
哪个 Visual Paradigm 版本支持此功能?
此功能在专业版或更高版本中提供。
仓库和项目必须托管在哪里?
仓库和项目都必须托管在 Visual Paradigm Online 中。
结论
OpenDocs 流水线提供了一种实用方法,可将 Visual Paradigm 图表与
结构化的项目文档连接。通过手动发布一次图表、跟踪后续
修订版本,并在编辑文档时选择适当的版本,团队可以保持
技术和业务文档的准确性,同时不会失去对文档基线的控制。
此工作流程对于定期更新系统模型、
软件架构图、流程模型和需求文档的团队尤其有价值。