Versions
规格
| 标签 | 值 |
|---|---|
| 版本 | 3.0.0（更新于 2024-06-10） |
| 开发者 | Labii Inc. |
| 类型 | 章节 |
| 支持配置 | 否 |
概述
Versions 小插件直接在章节中显示 Labii 记录已保存的版本历史，让用户可以查看以往状态、检查版本元数据，并在需要时还原较早的修订版本。每当记录发生更改时，Labii 都会自动创建新版本，无需手动创建快照即可保留记录随时间演变的过程。每条版本记录都包含版本号、提交消息、用户、时间戳和区块链式哈希键，有助于证明版本的完整性。该小插件与记录详细信息视图中的 Versions 选项卡提供相同的核心版本内容，但会让版本历史与记录本身并列显示。
使用场景
- 更改审查：无需离开章节视图，即可检查记录随时间发生的变化。
- 版本回滚：发生错误编辑或不需要的更改后，将记录还原到先前状态。
- 审计支持：提供包含时间戳、用户归属和不可变哈希引用且经得起核查的版本历史。
- 提交说明管理：重命名提交消息，使重要里程碑日后更易识别。
- 受监管文档：确认历史记录状态在受控工作流程中始终得到保留并可追溯。
界面
只读视图
在只读视图中，小插件显示当前记录的版本列表。每行都包含版本号、提交消息链接、创建该版本的用户、时间戳、加密哈希键和还原操作。哈希旁会显示验证样式图标，以强调注重完整性的设计。
- 版本列表：按时间顺序显示记录的版本历史。
- 提交信息可见性：显示自动生成或由用户编辑的提交消息，用于概括更改。
- 完整性元数据：包含每个版本的唯一哈希键。
- 恢复入口：为每个已保存版本提供直接还原操作。
只读视图列出已保存的版本及其提交详细信息、完整性哈希和还原操作
详细信息视图通常先加载最近的版本，并可根据需要加载更早的项目。
编辑视图
Versions 小插件不支持直接编辑版本内容。实际上，它的交互行为仅限于查看版本详细信息、更新提交消息、以只读方式预览版本，以及还原较早状态。版本记录本身由系统生成并自动保留。
- 输入方式：需要更清晰的标签时，通过版本条目控件编辑提交消息。
- 格式选项：版本根据记录更改生成，而不是手动输入的章节内容，因此不提供文档格式设置。
- 验证：还原版本会创建新的版本记录，而不是就地修改历史版本。
- 协作：多位用户可以查看同一版本历史，同时历史条目受到保护，无法直接覆盖。
更改记录时，Labii 会自动创建版本，因此用户无需为常规记录历史手动保存检查点。
配置
Versions 小插件不需要也不支持小插件专用配置。将它添加到记录后，会自动显示当前记录的版本历史。
初始设置
打开目标记录，并将 Versions 小插件添加到章节。
保存章节。小插件会立即加载当前记录已有的版本历史。
使用版本列表查看先前状态、重命名提交消息、预览已保存版本，或在需要时还原较早的修订版本。
必需设置
Versions 小插件没有必需设置。
可选设置
Versions 小插件没有可选设置。
还原先前版本不会删除后续历史。Labii 会创建一个新版本来记录还原操作。
其他功能
预览版本
点击某个版本的提交消息，以只读预览方式打开该历史状态。此预览采用与打印视图大体相同的呈现样式。
更新提交消息
使用版本条目旁的编辑控件，将默认或现有提交消息替换为更清晰的说明。这适合用于标记里程碑、澄清内容或有意进行的修订节点。
编辑提交消息不会改变底层版本内容，也不会影响其由哈希关联的完整性。
还原先前版本
点击 Restore to Version X，将记录恢复到所选的历史状态。Labii 会创建一个注明还原事件的新版本条目，以记录此操作。
搜索和筛选版本
使用与详细信息视图 Versions 页面相同的界面模式时，用户可以按关键词搜索版本列表，并筛选全部版本、已重命名版本或由当前用户创建的版本等视图。
检查完整性哈希
每个版本都包含唯一的哈希键，用于帮助验证历史记录未被更改。这有助于受监管工作流程中的可追溯性和可辩护性。
最佳实践
数据组织
- 为重要里程碑更新提交消息，使重要版本日后更易识别。
- 在修订可追溯性很重要的记录中使用该小插件，例如实验方案、已批准实验、质量事件和受控表单。
- 如果用户需要在作出审批决定前评估更改历史，请将版本审查功能放在签名或审计章节附近。
性能优化
- 当记录包含许多版本时，使用搜索和筛选工具缩小列表范围。
- 仅打开与当前审查相关的历史版本预览，而不是手动逐一浏览所有条目。
- 仅为有意的回滚事件使用还原操作，不要将其用于历史内容的常规浏览。
安全与合规
- 将哈希键和保留的版本历史视为支持合规的证据，而不是可编辑的说明。
- 谨慎使用还原操作，因为它们会创建新历史，并可能影响后续审查工作流程。
- 依靠不可变的历史链，而不要维护以往记录状态的非正式副本。
Versions 小插件与审批和审计追踪章节配合使用时尤其有效，因为它可以在同一记录中同时提供更改保留和恢复选项。
应避免的常见问题
- 避免认为还原版本会清除后续历史；Labii 会保留完整序列并添加新的还原版本。
- 避免在记录包含未来审查者需要快速找到的重要里程碑时，让所有提交消息保持默认形式。
- 正确做法是重命名关键版本，并在还原前使用预览确认准确的历史状态。
维护和故障排除
- 如果找不到预期的历史状态，请先加载更多版本或使用搜索/筛选控件，再判断它是否缺失。
- 如果版本标签不清晰，请编辑提交消息，方便日后审查。
- 如果需要为监管检查进行完整的历史审查，请将版本历史与 Activities 小插件结合使用，同时查看快照和事件级更改。
工作流程集成建议
- 将 Versions 小插件与 Activities 结合使用，同时查看已保存的检查点和各个更改事件。
- 当已批准记录以后可能需要审查签名前状态或拒绝后的状态时，将它与 Signers 配合使用。
- 当审计工作流程同时需要历史记录状态和访问历史时，将它与 Visitors 配合使用。
相关小插件
- Activities：显示逐项记录更改，与 Versions 提供的检查点式历史互为补充。
- Visitors：显示访问历史，在审查工作流程同时需要更改和查看证据时与版本历史互为补充。
- Signers：添加受控审批工作流程，此类流程通常依赖签核前后的版本审查。
- Visitors：当关键问题是“谁访问了记录”而不是“内容如何随时间变化”时，请选择 Visitors。