行业动态｜DPC《数字保存文档化:指南》译介（上）

2024-03-26

本期将为大家介绍数字保存联盟（Digital Preservation Coalition，DPC）于2023年9月发布的《数字保存文档化：指南》（Digital Preservation Documentation: a guide），该指南为数字保存从业人员提供如何高质量创建和管理文档的相关建议。由于篇幅过长，小编将分为（上）（下）两期向大家推荐。

1 数字保存文档化指南简介

对于组织或项目而言，文档化发挥着重要的作用，是数字保存良好实践的核心，也是推进数字保存成熟度模型（如DPC的快速评估模型(Rapid Assessment Model)和NDSA数字保存等级(NDSA Levels of Digital Preservation)）的必要条件。在申请数字保存认证（如CoreTrustSeal或ISO16363）时，文档化对于提供流程证据至关重要。进一步而言，AV公司的Amy Rudersdorf在DPC的一篇博文中（https://www.dpconline.org/blog/wdpd/document-this）充分说明了为何应腾出时间为数字保存实践创建文档。

编制高质量的文档无疑是好的实践，但并非总得到应有的关注。OSSArcFlow项目在2020年《原生数字档案工作流程文档化指南（Guide to Documenting Born-Digital Archival Workflows）》中指出：“当今绝大多数原生数字档案活动都没有得到很好的记录”。

造成这种情况的可能原因有很多。例如，OSSArcFlow项目指出：“大多数馆藏机构认为其原生数字档案工作流程仍然过于临时或不成熟，不值得正式记录。”有些情况下，人们不愿意将流程正式化，也不愿意在流程仍在发展的时候将其记录在纸上，但这样做有很多好处。

众所周知，数字保存工作人员需要具备创建文档的技能。在DPC的能力审核框架(DPC’s Competency Audit Framework)中，“宣传和沟通”能力领域涵盖了文档编制相关的技能，，并包括记录程序和工作流程、制作技术文档等示例任务。2022年，DPC听取了其成员的意见，认为分享如何创建文档的经验和技巧将会有所益处。为此，DPC于2023年初召开了一系列焦点小组会议，旨在促进知识交流，并将共享的信息收集到该在线指南中。

1.1 受众

该指南面向在工作中必须创建、更新和维护数字保存文档的数字保存工作者，为如何创建和管理高质量的文档提供了指导，且预设读者对数字保存的概念和流程有所了解。

1.2 范围

该指南中的“文档”（documentation）是指对于组织内数字保存的日常操作非常重要的文档，例如记录如何执行数字保存任务和程序以及如何集成和配置系统的文档。文档以文本和插图的形式存在，可与他人共享，而非仅存在于某个人头脑中的想法。如果数字档案团队的一名关键成员意外离职，其他人是否能够根据现有的文档接手他们的数字保存工作？数字档案馆的运作是否能够无缝、持续地进行下去？该指南将重点介绍有助于实现这些目标的文档类型。

然而，还有其他与数字保存相关的文档类型，但不属于该指南的范围：

• 该指南不涵盖数字保存政策和战略文件或与高层规划、报告或资源相关的文件。有关编写数字保存政策的指南可参阅DPC的数字保存政策工具包^[1]。

• 该指南不涵盖帮助理解单个文件或数据集的文档。这可能是数字内容附带的文档，使他人能够解读，也可能是档案馆工作人员随后形成的文件，以增强特定数据集的可用性。

• 该指南不涵盖保存元数据（PREMIS数据字典中描述的事件、代理人、权利和对象的元数据）。

2 文档的内容、原因和对象

2.1 文档应记录什么？

对于组织而言，尚未有开展数字保存活动所需文档类型的明确清单，但如果组织正在考虑认证，可能会需要一份作为证据的文档清单（例如，参阅2023-2025年CoreTrustSeal可信数字仓储要求(CoreTrustSeal Trustworthy Digital Repositories Requirements 2023-2025)）^[2]，其中包括建议提交的支持证据的详细信息。

以下清单并不详尽，但提供了焦点小组参与者提到的一系列示例。其中一些已归入数字保存工作流程的不同部分。

• 征集移交和摄取——例如，征集程序、移交或存储程序、预摄取和摄取程序、处理特定类型媒体载体的程序、标准化程序、内容鉴定和遴选指南。

• 比特流保存——例如，完整性检查过程、复制或移动文件的过程、所用存储位置的详细信息。

• 内容保存——例如，技术/保存观察审查流程，以及保存操作工具和流程的详细说明。

• 元数据管理——例如，元数据形成指南、元数据标准文档和使用中的受控词汇表。

• 发现和访问——例如，管理和提供数字内容访问的程序。

文档还可能包括数字保存工作人员的角色和职责、系统集成的技术细节、系统架构、服务器和存储器的资产登记册、数字保存/计算机取证设施的访问程序、内部可用的软硬件清单、退出策略以及与第三方的服务水平协议。

2.2 为何要编制文档？

2.2.1. 一致性

高质量文档化对于确保数字保存流程的一致性非常重要，使其不会受到具体人员和时间的影响。文档能确保工作流程的可重复性和可再现性，并确保组织内的流程标准化。

缺乏文档化的风险——个体的工作实践将很有可能出现分歧和不一致。即使只有一名员工执行某项流程，如果没有书面记录，也很容易遗忘步骤（尤其对于是不太经常执行的任务）。

2.2.2. 培训和知识管理

高质量文档化对于支持员工执行数字保存程序非常重要。不管是新员工在接受培训时需要查阅文件，还是现有员工想提高对数字保存程序的信心，文件都是分享知识的关键。

缺乏文档化的风险——文档对于继任计划非常重要，如果文档化实施不够完善，知识将会丢失。有关如何管理数字保存活动的信息不应只存在于一个人的头脑中！

2.2.3. 与他人沟通

高质量文档化成果是一系列内外部宣传和知识共享活动的重要工具。在某些情况下（除培训员工外），与其他人共享流程信息可能会对数字保存有所帮助，例如：

• 向赞助方和存储方表明正在遵循良好实践。

• 向数字内容的用户展示如何长期保持真实性。

• 与其他组织共享知识并比较流程（优秀案例如OSSArcFlow项目）。

• 与不同部门的内部利益相关者讨论数字保存活动，并帮助其了解自己在整个流程中的职责。

完整的操作文档将使员工共享和交流工作流程更为便捷。

缺乏文档化的风险——没有文档，就缺乏问责制。向他人证明正在遵循数字保存的良好实践也将变得更加困难，从而带来声誉风险。

2.2.4. 支持持续改进

高质量的文档化有助于组织内部人员以及第三方对流程和程序进行评估和分析。文档可以帮助识别差距或操作瓶颈，并促进改进。文档也为流程分析提供了机会。有人指出，创建文档的过程本身对于帮助项目合作伙伴认识并阐明痛点、然后采取措施解决问题非常重要。

缺乏文档化的风险——组织就难以评估流程、了解出错原因并从错误中汲取教训。如果工作流程没有完善的文档（尤其是由第三方进行评估的情况下），那么调试和改进工作流程将会很困难。

2.2.5. 支持认证

对于申请认证的机构来说，高质量文档化是一项基本要求。根据所申请的计划或标准，机构需要提供文件作为证据，以证明正在按照适当的标准展开数字保存。

缺乏文档化的风险——组织将无法证明其成熟度或满足认证要求。

2.2.6. 透明度和真实性

对于数字保存而言，证明所保存内容的真实性、保证其公开和透明至关重要。高质量的文档化支持这一点，确保了对保管链和来源的捕捉，以及对过去流程和工作实践的历史理解将在未来可供查阅。这将使未来的保管者和用户能够理解在不同时间点的工作流程、行动和决策，从而使他们能够评估所保存信息的可信度。

缺乏文档化的风险——组织将会缺乏透明度，且将难以展示自己当前和以往的工作实践。这可能会导致所保存的数字内容失去可信度。如果没有记录数字内容管理方式的文件，将难以确定内容的真实性。

2.2.7. 支持内部规划和管理

数字保存的高质量文档化可在许多方面支持数字保存活动的有效管理。它可用于支持资源请求、管理不断变化的需求并帮助进行前瞻性规划、为员工分配明确的角色和职责、更好地了解并减轻风险以及更好地了解组织变革的影响。

缺乏文档化的风险——数字保存在组织内部的可见度可能较低，从而导致缺乏监督，且支持资源配置请求将变得更加困难。

在编制文档方面找到适当的平衡非常重要。在关注到文档化好处的同时，也要注意过度文档化、文档不准确或过时的潜在风险。创建和维护文档需要时间和精力，意味着用于其他活动上的时间将减少。重要的是，需要了解所需的投入，并确保留出时间来保持文件的最新性和相关性。

同时，还要确保文档化工作不会导致流程和程序的停滞。尽管稳定有所益处，但在数字保存的学科领域中，也必须为新的想法和创新留出空间。不要因为文档化的规定而坚持执行相同的过时流程，应适时审查和推进数字保存实践，并确保文档也得到相应更新。

2.3 为谁编制文档？

在创建任何形式的文档时，应考虑为谁创建文档以及他们可能需要访问文档的原因。不同的组织环境会有一些差异。下表定义了一些主要受众。

注意事项：

• 无需满足所有受众的需求，而是要仔细考虑机构所服务的对象，因为这将影响机构在创建文档和提供文档访问时如何确定文档的详细程度、格式、语言和平台。

• 既要考虑未来的受众，也要考虑现在需要访问文件的受众。

• 读者的数字保存知识水平很可能会因文档的特定受众而异，应确保对内容进行适当调整。

3 什么是高质量文档化和文档化不足？

焦点小组参与者通过Jamboard工具集思广益，讨论了高质量文档化和文档化不足的一些特征。下表总结了讨论的要点，有助于帮助机构评估现有文档化工作或为实施文档化提供一些基本原则。

4 创建文档

4.1 了解你的组织

组织通过使用系列工具和平台，以多种不同方式形成和管理文档。组织可能具有与文档化相关的特定流程——例如测试、沟通和批准。由于找到一种适合组织环境的方法非常重要，因此组织应该做一些探索性的基础工作，以确保通过正确的方式完成任务。

• 已存在哪些数字保存文档？组织内部可能已经有一些文档。找出已经存在的成果文档：在哪里？谁拥有它？是最新的吗？是什么格式？需要弥合的差距在哪里？你可与同事讨论以帮助回答上述问题，因为可能存在你不了解的现有文档。应确保解释“文档”这一术语涵盖哪些类型的材料。同事可能拥有此类资源，但尚未意识到其属于“文档”（例如非正式清单或记录流程的“备忘单”）。

• 在组织或部门内创建文档化的流程是什么？需要谁参与？是否要求或鼓励签署或批准文件？遵循正式的程序有助于确保一致性和质量。

• 组织内使用哪些工具、平台和文件格式来形成文档？与同事讨论上述行动的有效与否，并了解其他部门的做法——组织中可能有不同的做法可供借鉴。

• 组织内是否有文档样式指南或模板？你可以利用指南或模版，或对其进行调整以满足特定目的。

4.2 编写文档的技巧

• 采取灵活的方法——准备好在编写过程中对文件进行调整，以便找到适合自身和目标受众的风格。

• 在开始填写细节之前，尽量先确定文档的基本结构——在早期阶段通过合作或从同事中获得反馈意见将对此有所帮助。

• Write the Docs网站提供的一个有用建议是：确保“文档可略读”——文档可能很长（通常是出于必要），但用户不太可能希望逐行阅读所有内容。清晰的标题、一致的风格以及尽可能早地出现在段落和列表项中的关键词，将有助于用户快速找到其感兴趣的部分。

• 文档应该易于理解和解释——尽可能使用通俗易懂的语言（可参考新南威尔士州政府的指南）。此外还需要考虑文档的可访问性，这方面澳大利亚政府提供了有关编写易访问和包容性内容的指南^[3]。

• 考虑文档的详细程度——如果记录一个流程，通常应该描述要做什么以及如何做。但在某些情况下，简要描述为何要执行某个流程或做出特定决定也可能会有所帮助。程序的合理性有助于员工参与，因其可以看到所需努力的理由和益处。

4.3 用于创建文档和提供文档访问的工具和平台

许多不同的工具和平台可用于创建文档和提供对文档的访问，这些工具和平台各有利弊。应明确组织内部可以使用哪些工具，并考虑哪些工具最能满足受众需求。

在决定创建和更新文档的工具或方法时，还需要考虑以下几点：

• 谁需要更新文档？一人还是多人？如果是多人，应如何管理？

• 组织中是否有打印文档的文化？如果是，能否使用一个平台为使用实时（即最新）版本创造价值？

• 如何提供对文档的访问？能否使用一个平台，以合理直观的方式显示所有可用文档，让用户轻松查看所有当前版本的文档，并允许它们之间相互链接或交叉引用？

• 是否需要为不同受众提供文档的不同元素？是否有工具或平台可实施这些访问权限？

• 文档需要多久更新一次？如果需要经常更新，则不要在所使用的工具和平台上设置障碍（例如，每次更新后都需要将文档转换为pdf格式并上传）。

• 是否需要保存历史版本文档？是作为特定时间点的文件保存，还是能够在适当的情况下回溯至遗忘版本？如果存在上述需求，应考虑工具如何支持需求。

• 如何从形成或托管文档的平台中获取文档？若计划让文档实现比其所在的平台或格式更长久的保存，可能需要对文档实施长期保存，并应始终考虑退出策略。

• 谁拥有该文档？如果所使用的工具或平台（例如 Google云端硬盘）将文档所有权分配给了特定帐户持有人，应确保制定一套流程，以便在该个人离开组织时保留对此文档的访问权限。

除了用于创建和托管文档的工具或平台之外，项目管理工具也可帮助管理维护文档的过程。下表概述了部分工具和平台。

4.4 模板和风格指南

高质量文档的特征之一是一致性。格式、结构和语言的一致性都有助于提高可用性，特别是对于长文档或大量文档而言。统一使用特定平台或文件格式也有所帮助，因为用户将很快熟悉所使用的风格、格式和惯例，有助于更有效检索相关信息。一些组织使用模板或风格指南来帮助其实现这一目标。模版也非常有用，特别是在确保不遗漏关键导航和结构元素（例如目录、页码）或有关文档历史记录信息（例如所有者、创建者、上次更新日期、审阅日期）方面。

组织可能已经有一个文档模板，适用于受众的直属部门、相关部门（例如 IT）或更广的范围。如果组织倾向于特定的项目管理方式或方法，则可能包括用于记录标准操作程序的模板和流程。

OSSArcFlow项目开发的《原生数字档案工作流程文档化指南》（The Guide to Documenting Born-Digital Archival Workflows）提供了一项模板，包括项目合作伙伴创建的工作流程图中所使用符号和约定的图例。

风格指南同样是一项有用的工具，有助于确保格式和语言使用的一致性。

• Write the Docs网站^[4]提供了大量与文档样式指南相关的内容。

• 英国政府风格指南^[5]包含了一些常识性建议，指导如何使用简洁明了的语言进行写作（包括相对专业的主题）。

• 澳大利亚政府的风格手册^[6]，包含关于语法、标点符号以及使用通俗语言的建议。

4.5 插图和图表

添加屏幕截图或清晰翔实的图表，可以大大提升文档的质量。当目标受众的学习风格、偏好和能力各不相同时，图片和文字将会很有帮助。但对工作流程的图形化表达可能不适合有视觉障碍的人，因此需考虑是否可以用其他方式来传达这些信息。

屏幕截图易于制作并纳入文档。截图有助于提高清晰度——例如，在描述如何配置工具时，使用相关对话框截图辅助说明会很有帮助。但随着工具的发展，截图可能很快就会过时，而且过多使用截图会使文档变得庞大且难以处理。

图表在帮助解释复杂信息、决策或工作流程方面尤为有效，许多工具可用于创建有效的图表，而且查看其他组织的示例也会有所帮助。

4.5.1 工具

OSSArcFlow项目提供了一些有关创建图表的有用建议。项目团队使用 LucidChart创建工作流程图，并提供了使用惯例来说明工作流程中不同要素。

社区工作流程（Community Owned Workflows, COW）^[7]中提供了有关创建图表的进一步建议。

无论选择使用哪种工具来创建图表，都需要注意一些问题和陷阱。避免图表过于拥挤且文本难以辨认，需要在所包含的信息量与最终产品的清晰度和易读性之间取得平衡。

4.5.2 示例

• OSSArcFlow项目——作为该项目的一部分创建了一系列“按原样（as is）”工作流程^[8]，这些工作流程都是使用类似的工具和习惯创建的。

• 社区工作流程 (COW)——COW wiki页面上共享了一系列工作流程图——可参阅为基于云的Wellcome收藏的MXF和MPG视频保存和访问工作流程创建的图表^[9]。

4.6 测试文档

测试文档是获取目标受众反馈的好方法。让受众看到已创建的文档，询问他们是否清晰易懂，观察他们是否跟得上或发现任何差距。

参考链接

[1]https://www.dpconline.org/digipres/implement-digipres/policy-toolkit

[2]https://zenodo.org/records/7051012

[3]https://www.stylemanual.gov.au/accessible-and-inclusive-content

[4]https://www.writethedocs.org/guide/writing/style-guides/

[5]https://www.gov.uk/guidance/content-design/writing-for-gov-uk

[6]https://www.stylemanual.gov.au/

[7]https://coptr.digipres.org/index.php/Contribute_your_workflow_to_COW

[8]https://educopia.org/ossarcflow-as-is-all-workflows/

[9]https://coptr.digipres.org/index.php/Workflow:Cloud-based_preservation_and_access_workflow_for_MXF_and_MPG_video

翻译：黄思诗

校对：武晓璇、贺谭涛、张茜雅

排版：张开霞

审核：钱毅

学生研究员风采

黄思诗

武晓璇

贺谭涛

张开霞