管理 > 创建内部文档 > 概念 > 内部文档概述

内部文档概述

“内部文档”功能允许您将自己的自定义文档 (文本或 URL) 添加到现有的联机帮助中。

用户可以在产品的相关区域中单击“帮助”按钮 来访问此文档。“内部文档”标题下的产品“帮助”中将显示一个链接,链接到的页面会显示您的文档。

您可以在“管理员”模块的“内部文档”窗格中创建内部文档。有关详细信息,请参阅内部文档窗格

示例:

John 是 ABC 组织中的 Release Control 管理员。Web 管理员 Sue 告诉 John 她将在每周一执行网站维护,并让 John 在 Release Control 中创建一个时间段类别,以限制所有人在周一对公司的网站进行更改。

John 创建了名为 Web_blackout 的时间段类别。当 Release Control 用户进入“分析”模块的“评估”>“时间段冲突”选项卡时,可能会发现他们计划的变更与 Web_blackout 时间段有冲突。John 希望用一种方式来向用户解释此时间段类别存在的原因,于是决定编写内部文档。

他进入“内部文档”窗格 (“模块”>“管理员”>“配置”选项卡 >“内部文档”),在“产品区域”窗格中选择“时间段冲突”,然后填写必填字段并保存所做的更改以提交文档:

当用户进入“分析”模块中的“评估”>“时间段冲突”选项卡并单击“帮助”按钮 时,产品帮助中将显示一个链接,该链接指向 John 编写的解释新时间段的文档。

当用户单击该链接时,将会打开一个单独的页面,其中会显示 John 提交的内容。John 也可能已决定在内部公司网站上记录时间段,并插入一个 URL,而不是在“内部文档”窗格中提交文本。在这种情况下,该链接会直接打开 URL。