概览图将 OpenDocs 呈现为一个用于创建图表、协同编写文档、组织知识，并共享或发布成果的地方。一种实用的使用方式是将每个文档视为持续维护的知识库的一部分，而非一次性文件。
OpenDocs 被描述为一个基于 Web 的知识管理和文档环境，它将书面内容与可视化模型整合在一起。Visual Paradigm 的流水线（Pipeline）还可以将 Visual Paradigm 桌面版或在线版中创建的图表连接到 OpenDocs，从而减少对手动导出的静态图像的依赖。可用功能可能取决于您的 Visual Paradigm 版本和配置。
1. 规划知识库
在编写页面之前，先确定该空间的用途以及使用者是谁。结构清晰有助于人们查找和维护信息。
例如，产品或系统知识库可以按如下方式组织：
-
概览——目的、范围、负责人以及关键页面的链接
-
架构——系统上下文、组件、集成和部署
-
流程——工作流、程序和决策点
-
数据——实体、数据流和定义
-
运维——运行手册、监控、恢复和支持联系人
-
决策——设计选择、依据和后果
-
术语表——共享术语和缩写
保持顶层结构简洁。将详细内容放在专注的子页面中，并将相关页面相互链接。
2. 创建清晰的概览页面
从帮助新读者快速上手的页面开始。包括：
-
目的：本知识库涵盖的内容。
-
受众：谁应该使用它。
-
范围：包含什么——如果有益，还应说明不包含什么。
-
所有权：谁负责维护内容。
-
导航：链接到最重要的部分。
-
时效性：审核日期或报告过时内容的指引。
为不了解该项目的读者撰写。展开不常见的缩写，并解释重要图表背后的背景。
3. 起草并构建内容结构
OpenDocs 支持在同一工作区中进行文档编写和可视化内容创作。搜索结果描述了一种面向 Markdown 的编辑器，在某些工作流中还提供所见即所得（WYSIWYG）的编辑体验；请使用您账户中可用的编辑模式。
一个可靠的页面模式如下：
-
摘要：用几句话概括核心要点。
-
背景：说明该主题为何重要，以及适用的假设。
-
可视化内容：用于解释结构、行为或关系的图表。
-
详情：定义、步骤、规则或辅助说明。
-
相关页面：链接到前置条件和后续材料。
-
负责人和审核日期：谁负责检查该页面以及检查时间。
对于操作流程，优先使用描述性标题、简短段落和列表。当读者需要比较字段或浏览结构化事实时，使用表格。避免让图表承载文本从未解释的信息。
4. 选择能回答问题的图表
根据您希望读者理解的问题选择合适的可视化模型：
-
流程图或 BPMN：发生了什么，以及发生的顺序是什么？
-
UML 用例图或活动图：谁与系统交互，以及发生了哪些行为？
-
UML 组件图或部署图：各组成部分是什么？它们如何排列？
-
序列图：参与者如何随时间进行通信？
-
实体关系图（ERD）：存在哪些数据实体？它们之间如何关联？
-
思维导图或概念图：想法如何分组和连接？
-
甘特图、路线图或工作分解结构（WBS）：计划了哪些工作？它们如何相互衔接？
Visual Paradigm 材料描述了涉及 UML、BPMN、ERD、思维导图和项目规划可视化等图表类型的 OpenDocs 工作流。在围绕特定图表类型构建流程之前，请确认您的版本中是否支持该图表类型。
为每张图表添加标题和简短说明。定义缩写，标注重要边界，并确保详细程度适合目标受众。如果图表难以阅读，请将其拆分为一个高层视图和一个或多个详细视图。
5. 将图表添加到文档中
概览图表明了一个简单的创作周期：创建可视化内容，将其放置在能支持文本的位置，并说明如何阅读它。
一个实用的顺序是：
-
首先撰写周围的说明文字，以便图表具有明确的目的。
-
在您可用的编辑器或建模工具中创建图表。
-
使用您账户提供的集成功能，将图表插入或嵌入到相关页面中。
-
添加标题或附近的文字，描述其范围及核心要点。
-
检查标签在读者将使用的页面宽度下是否清晰可读。
-
以读者的视角审查页面，而不仅仅是在编辑视图中查看。
当图表通过 Visual Paradigm 的流水线发送时，源文件描述了将模型工件提供给 OpenDocs 并选择其在文档中使用的流程。这有助于减少过时副本，但团队仍应验证嵌入的工件是否指向预期的模型和修订版本。
6. 通过轻量级评审流程进行协作
使用一致的流程，使协作能提高准确性，而不是产生冲突的编辑：
-
分配责任：为每个重要页面或章节指定负责人。
-
起草：撰写内容，并包含解释所需的可视化元素。
-
评审：请领域专家检查内容的正确性，并请团队外部的读者检查内容的清晰度。
-
解决变更：就正文和图表的修订达成一致。
-
发布或共享：将已审核的版本提供给目标受众。
-
重新审视：当系统或流程发生变化时，重新审查该页面。
该图片展示了团队协作，但具体的协作控制和可用性可能有所不同。请查看您 OpenDocs 工作区中显示的控件，而不要假设所有账户都支持相同的共享或编辑选项。
7. 组织并维护知识库
良好的知识库需要持续维护。保持页面简洁以便快速浏览，使用一致的标题，并链接相关主题，而不是在多处重复相同的解释。
对于每个重要页面，请跟踪：
-
明确的负责人
-
目标受众
-
链接模型或数据的权威来源
-
上次审查日期
-
任何已知的限制或未解决的问题
当图表发生变化时，也要审查其周围的文本。图片可能是最新的，但解释、术语或链接的流程可能已过时。
8. 审慎地共享或发布
在共享页面或空间之前，请检查：
-
目标受众是否能够访问
-
内容是否包含敏感或仅限内部的信息
-
共享视图是否按预期显示图表和布局
-
接收者需要的是单个页面还是整个知识库
-
材料是否已准备好供外部读者阅读
具体的共享和发布选项取决于账户和配置。请将概览图片中的“共享”阶段视为工作流程目标，而非特定发布目的地或权限模型的保证。
9. 可复用页面检查清单
在认为页面已就绪之前，请确认它：
-
具有清晰的标题和目的
-
对目标受众而言易于理解
-
定义了不熟悉的术语
-
使用能够回答特定问题的图表
-
用文字解释重要图表
-
链接到相关页面和原始资料
-
标明负责人和审核日期
-
已在共享视图或面向读者的视图中经过检查
示例工作流程
在记录新服务时，首先创建一页概述，说明其目的和归属。添加系统上下文图以展示其用户和外部依赖关系。为其主要部分创建组件图，然后在单独的页面上记录关键请求流程和操作程序。从概述页链接这些页面，与服务团队一起审核它们，并向目标受众共享适当的视图。如果底层模型发生变化，请更新或重新检查相关图表及其说明。
核心原则很简单：保持写作、图表、组织和共享流程的连贯性正是这一点将一堆页面和图表转化为有用且可维护的文档。