Logo Logo

S1000D 5.0 中文版

/

1.4 如何为特定项目裁剪

1 概述

本章为特定项目或者组织裁剪 S1000D 提供业务规则和在何处查找信息提供基本介绍。

2 内容

第 1.4.1 章介绍了 S1000D 的裁剪，并总结了在哪里可以找到与定制相关的信息。第 1.4.2 章定义了裁剪时为了遵守规范而必须满足的要求。

1.4.1 如何为特定项目裁剪 - 裁剪介绍

1 概述

本章为特定项目或者组织裁剪 S1000D 提供业务规则和在何处查找信息提供基本介绍。

2 内容

本规范适用于多种不同类型的产品。因此，为了使其适用于给定的项目或组织，需要进行一些裁剪。建议在项目合同文件中说明裁剪参考本规范的版本。这种裁剪不得影响 XML Schema 或其基本原理，但必须限于在叙述性规范中进行裁剪。

参与方必须就项目业务规则达成一致，以记录本规范商定裁剪的细节。这些规则必须涵盖可选元素的要求、特定数据源中的元素数量以及特定值的使用。

第 2.5 章定义了术语“业务规则”，并描述了 S1000D 中业务规则范围的标准化。第 2.5.1 章对各种业务规则进行了分类，并介绍了业务规则层的构造，这些层描述了生成业务规则的各种组织和项目级别。第 2.5.2 章介绍了业务规则的生成和使用机制。第 2.5.3 章包含业务规则决策点的完整索引。

第 4 章介绍了 BREX 机制，该机制用于记录和交换项目各方之间的特定业务规则。

第 3 章至第 8 章为项目和/或组织特定的业务规则决策提供指导。

1.4.2 如何为特定项目裁剪 - 一致性和符合性

1 简介

为组织或项目实施 S1000D 涉及规范的裁剪。在进行此类裁剪时，有必要了解在不离开 S1000D 概念的情况下可接受的裁剪类型和程度。本章给出了构成 S1000D 5.0 版一致性和符合性定义的标准。这些标准不一定适用于未来的版本。

2 一致性和符合性

2.1 背景和基础

S1000D 提供了一个完整的过程和一组支持工具，例如用于表示不同类型信息的预定义结构/XML Schema。遵守 S1000D 规定的过程和工具的程度被表示为对规范的一致性和符合性。

与一致性和符合性相关的要求仅适用于信息交换和交付。该规范没有规定在暴露于外部环境之前，在生产环境中如何处理特定的过程步骤或对象。

2.1.1 关于认证

虽然 S1000D 定义了 S1000D 一致性和符合性的含义，但并不正式认证或认可任何第三方 S1000D 对象、过程、软件或其他信息产品。

2.2 定义

在这种情况下，第 2.1.1 段至第 2.2.3 段中的定义适用。

2.2.1 一致性的定义

“一致性”指的是一个或另一个对象的形式与该对象必须如何形成的规范的相似性。

定义：一个对象或一组相关对象符合 S1000D，当且仅当其满足 S1000D 规定的此类对象的形式要求（例如，数据模块可以符合要求）。

2.2.2 符合性的定义

“符合性”是指遵守规范中定义的一个或另一个过程或程序。

定义：过程步骤、程序等符合 S1000D，当且仅当其按照 S1000D 规定执行时，且不违反第 2.2.1 段中的标准（例如，表示责任合作伙伴公司的代码分配可能符合）。

2.2.3 CSDB、CSDB 管理体系和 CSDB 对象的定义

有关术语 CSDB、CSDB 管理系统和 CSDB 对象的定义，参考第 4.2 章。

2.3 标准

S1000D 提供了涵盖文件编制过程各个方面的规则、指南和工具。在每个方面，功能都作为一组功能和规定以及一组对象类型提供。

有关特定方面的一些要求对于获得普遍可理解的 S1000D 信息至关重要。这些要求构成了 S1000D 一致性对象和符合性过程的核心标准。

除了核心标准外，本规范还为规范用户提供了许多 S1000D 具体方面的选择，一方面是应用其提供的条款，另一方面是用替代解决方案替代它们。

可以定义一致性/符合性标准的 S1000D 方面包括：

  • 通用、整体的属性
  • 文件编制过程
  • CSDB 及其包含的 CSDB 对象
  • CSDB 之间的数据交换
  • 以面向页面的格式向用户交付和展示信息
  • 以 IETP 的形式向用户交付和展示信息

为了反映上述情况，以下定义的一致性和符合性标准组织如下：

1 核心标准

这些标准是必须满足的，以达到 S1000D 一致性和合规性。参考第 2.3.1 段。

2 方面选项的标准

为了实现相关方面的一致性和/或符合性，每个方面必须满足特定标准。然而，这些方面本身可以是完全符合或部分可选地符合。参考第 2.3.2 段。

一个方面涵盖特定功能领域，例如 IETP 的生成、CSDB 管理等。参考图 1。

图 1 方面核心与方面选项的简化图示
2.3.1 核心标准

当且仅当其满足以下标准时，CSDB 对象与 S1000D 核心一致，相关过程符合 S1000D 核心。

2.3.1.1 一般标准

符合本文中与 S1000D 5.0 版相关标准的 CSDB 对象为“一致于 S1000D 5.0 ”（或“与 S1000D 5.0 一致”）。

注：图形和多媒体对象可能符合多个 S1000D 版本，因为它们不受给定 S1000D 版本的 Schema 控制。

2.3.1.1.1 Schema 与规范文本

S1000D 过程、对象等的属性在规范文本中定义。XML 对象结构由 Schema 定义。

关于遵守 Schema 和规范文本的标准：

与 S1000D 一致 的 XML 对象必须满足适用规范文本和参考 XML Schema 定义的要求。除非 S1000D 明确支持，否则 XML 对象不得依赖于命名空间或任何其他 XML 数据和功能，以完全可理解并可根据需要呈现。

2.3.1.1.2 业务规则

关于业务规则的标准：

一个项目或者组织的业务规则必须被定义、记录、并将其提供给需要接收、创建、管理或交付符合这些规则的 CSDB 对象的任何一方。

在分层业务规则结构中，对某一级别有效的业务规则必须遵守父级业务规则。最终，项目或组织的业务规则必须遵守 S1000D 默认 BREX 数据模块中指定的业务规则。

CSDB 对象必须遵守其编写和/或引用的业务规则。

2.3.1.2 文件编制过程标准

有关文件编制流程的标准：

要符合 S1000D 文件编制流程，文件编制流程必须至少满足第 3.9.5.1 章（包括子章节）中描述的有关以下方面的要求：

  • 对象的已发布和未发布版本的要求
  • 安全和数据限制要求
  • 质量保证要求
2.3.1.3 CSDB 和 CSDB 对象标准

2.3.1.3.1 CSDB 对象，概述

与 Schema 一致性相关的标准：

CSDB 中的任何 XML 对象都必须完全符合 S1000D 提供的 5.0 版 Schema 之一（如 CSDB 对象的模式声明所示）。

请参阅默认的 BREX 规则 BREX-S1-00027、BREX-S1-00028 和 BREX-S1-00246、BREX-S1-00247、BREX-S1000D-00248、BREX-S1000D-00249 和 BREX-S1-00250。

任何一个 XML 对象都必须包含对 S1000D XML Schema 的引用，其目标结构如规范所述。请参阅第 7.3.1.3 章。

2.3.1.3.2 CSDB 对象标识和状态

关于对象标识的标准：

CSDB 对象的标识，包括不是 S1000D 识别的 XML 对象的对象，必须完全符合适用于其对象类型的标识数据结构。

除本规范提供的例外情况外，数据模块代码的识别原则必须适用于数据模块。标识必须建立在两个部分上：

  • 第一部分标识产品项（包括拆分代码变体）
  • 第二部分确定了项目的信息类型

关于识别码的标准：

当且仅当其不偏离规范提供的 Schema 时, CSDB 对象符合 S1000D。

关于对象状态的标准

交换的 CSDB 中所有 XML 对象必须包含 S1000D 版本所需的一组状态/元数据项。

2.3.1.3.3 CSDB 对象内容部分

元素和属性的使用标准：

符合 S1000D 的对象必须根据 S1000D 中表达的定义使用元素和属性，包括参考的 XML Schema 和默认的 BREX。

2.3.2 关于方面选项的标准

以下标准均与 S1000D 的功能方面有关，它们是可选的。因此，可能是 S1000D 核心 一致的/符合的，但选择不一致/不符合规范中描述的各种选项。

然而，为了达到 S1000D 一致性和/或所列任何方面的符合性，必须满足该方面的标准。

本规范未明确涵盖的方面不会影响一致性和符合性的程度。此外，在规范中确定了决策点的地方，项目可以在决策点的范围内做任何事情，并且仍然是一致的/符合的。

与过程相关的标准：

要符合 S1000D 过程，必须采用文件流程：

  • 符合 4.5 章要求的 DMRL/CSL 对象
  • 符合 4.6 章的评论对象

与传输相关的标准：

符合 S1000D 要求的数据传输包必须满足第 4.8 章和第 7.5 章中规定的所有适用要求。

与 CSDB 交付相关的标准：

符合 S1000D 的 CSDB 数据交付包是根据第 2.3.1.3 段、第 4.8 章和第 7.5 章定义和传输的数据包。

与 IETP 交付相关的标准：

符合 S1000D 的 IETP 数据包是根据第 2.3.1.3 段定义和传输的数据包，包括符合第 4.8 章、第 7.4.1 章和第 7.5 章规定的 IETP 中性存储库格式的对象。

与面向页面的格式出版物相关的标准：

符合 S1000D 要求且符合面向页面格式的数据包必须满足本规范第 6.2 章规定的要求。

与 IETP 演示相关的标准：

符合 S1000D 的 IETP 演示文稿必须满足本规范第 6.3 章规定的要求。


< 回到目录