S1000D最初是由欧洲航空工业联盟开发的技术出版物规范它主要为具有较长生命的复杂产品运行和维修而设计。这些年不断发展已经扩展到这些行业的产品国防系统 - 包括海、陆、空的产品民用航空产品基建行业产品和船舶工业产品。

这篇文章我们来概览这个长达3500页的规范。

- 1 -

S1000D是什么

根据S1000D官网S1000D是使用公共源数据库的技术出版物的国际规范。

它强调内容重用、降低整体成本、并且是免费的。 

它非常大有3500多页。

它使用XML来将内容结构化。

- 2 -

S1000D的愿景和使命

愿景

成为产品支持生命周期中最被全球采用的技术信息规范。

使命

利用标准化数据结构和业务规则提供具有前瞻性、模块化、平台中立的规范使全球用户能够优化技术信息的重用和互操作性。

- 3 -

规范的组织结构

S1000D规范涉及技术信息管理的整个生命周期所有的活动。

它不仅仅是用于交换的数据规范。它涵盖了怎样规划项目、确定范围和深度、怎样编写信息、怎样管理信息、纸质手册样式、交互式电子手册的功能等。这是它和其他规范如DITA、ATA2200的不同之处。这也是这个规范有3500页之多的原因之一。

以下是使用S1000D来编制文档的流程同时标注了每一步与S1000D规范章节的对应关系。

 以下是S1000D规范各章节的内容概要

- 4 -

核心概念

1. 数据模块 - Data module

传统手册/技术出版物是以文档为中心管理也是以一本手册/出版物为单元。S1000D的思路是将手册打碎成小块然后将小块内容组装成手册。这个小块被称为数据模块是信息的最小单元。 

数据模块包含两部分内容和元数据

元数据就是说明内容的数据比如内容模块的作者、适用的产品型号、谁有权阅读等属性。 

每一个数据模块有一个唯一编号叫做DMC (Data Module Code)

2. 数据模块代码 - Data Module Codes (DMCs)

S1000D中每个数据模块有唯一的编号这个编号就是DMC。DMC遵循下边的规则

3. 公共源数据库 - CSDB

CSDB是用来存储用于创建项目技术出版物的所有信息对象的数据库。

4. 出版物模块 - Publication modules

S1000D使用出版物模块PM的概念也就是手册从CSDB中包含的数据模块来构建出版物。

PM包含出版物中所需的数据模块列表并按其出现的顺序列出。

PM可以包含对其他PM的引用。

5. 业务规则和业务决策点 - Business rules/BRDPs

业务规则代表有关企业如何开展业务的政策、程序和约束。

如前所述S1000D涵盖整个技术信息的生命周期。S1000D规范不是完全固定的有些地方项目可以根据自己的情况来决定。决策点就是需要做决策的地方。比如

这个决策点是项目需要选择使用的S1000D的版本。

再比如

这个是要决定是否使用reqTechInfoGroup标签以及如何使用。

S1000D 4.2版本中一共有428个决策点他们分为以下类型

 

6. 业务规则交换 - BREX

BREX (Business Rules Exchange) 提供了一种“交换”业务规则的机制。

比如

- 5 -

使用S1000D规范的好处

1. 通过内容重用降低技术信息的维护成本 

通过内容重用减少修改、翻译和维护内容的数量从而降低维护成本。

2. 防止信息重复

通过规划有效的内容重用机制最大程度地降低和防止维护多份相同的内容。

3. 允许生成信息集以满足特定用户需求

S1000D中数据模块是内容的最小单元。根据场景和需求将相关的数据模块组合起来形成信息集满足需要。

4. 促进不同系统之间的信息传输

S1000D的内容符合S1000D规范可以在产业链企业和企业的信息系统中以及企业内部不同的系统中进行数据交换。 

5. 支持多种不同的输出格式

S1000D使用XML作为基石可以实现单一数据源多渠道发布。

6. 可应用于旧数据

S1000D规范不仅可以使用XML也可以将MS Word、PDF、视频等非结构化内容作为数据模块。

7. 国际中立标准

S1000D标准不属于任何一个国家。

8. 非专有且基于开放标准

S1000D基于开放的标准如XML、PNG等。S1000D是一个不属于任何一个企业。

9. 它是免费的

可以通过S1000D官方网站免费下载www.s1000d.org

 

---

大龙谈技术出版物