DITA与S1000D的相同与不同
DITA和S1000D是全球最出名的兩種文檔規范。這兩個規范用于創建、管理和發布各種類型的文檔。他們將內容分解成自包含的內容塊,每個內容塊有自己的類型,然后通過一定的形式將這些內容塊組織成文檔。他們的基本原則都是內容重用和單源發布。
那他們之間有什么相同點和不同點呢?各自的應用場景如何呢?今天聊聊這個話題。
一、DITA與S1000D的相同點
1. 基于XML,都是開放的規范
DITA和S100D都是基于W3C(萬維網聯盟)的XML等標準設計的規范。
DITA由OASIS DITA技術委員會定義和維護。OASIS DITA技術委員會的參與者來自這些公司和組織:
- Adobe Systems
- Cisco Systems
- Dell
- Huawei Technologies Co., Ltd. – 華為
- IBM
- IXIASOFT
- Microsoft
- Oracle
- SAP SE
- SDL
- 美國國防部
S1000D由來自民用和國防航空行業以及國防陸海工業的商業和技術專家組成的國際團體開發和維護,參與方包括客戶、供應商和解決方案提供商。
S1000D理事會是根據歐洲航空航天和國防工業協會(ASD)、航空航天工業協會(AIA)、ATA電子商務計劃(ATA e-Business Program)之間簽署的諒解備忘錄成立的。理事會的主要任務是對S1000D的開發進行全面管理。
S1000D指導委員會是一個代表對規范有共同興趣的國家和組織的成員機構。S1000D 指導委員會通過處理變更提議表來維護S1000D規范。
兩個規范都可以從各自的網站免費獲取。
2. 相同的理念
有別于傳統將一個文檔作為單元來管理的方式,DITA和S1000D將內容分解成內容塊,然后通過一定方式將內容塊組織起來形成文檔。內容塊是自包含的最小管理單元,一個內容塊可以在不同的地方重用。
內容塊
內容塊在DITA中叫主題(Topic),S1000D中叫數據模塊(Data Module – DM)。每個內容塊由內容和元數據組成。
規范中都設計了內容塊的類型。
內容組織機制
通過相似的機制將內容塊組織起來。在DITA中使用圖(Map),在S1000D中使用出版模塊(Publication Module – PM)。
3. 單一數據源,多渠道發布
編寫好的內容塊是XML格式的,它是純文本的文件,不包括怎樣顯示的信息。通過提供不同的樣式,可以將相同的內容發布成的輸出格式,用于不同的場景使用。
4. 提供個性化內容
使用DITA或者S1000D編寫文檔,最重要的一個特性之一就是能夠提供個性化內容。這是邁向智能化信息的基礎,也是人們從MS Word/Markdown轉向DITA/S1000D寫作的重要原因之一。?
所謂的個性化內容就是根據手冊使用者的需要(操作的設備、讀者的角色、當前所處的場景等),提供內容。這就是在正確的時間,在正確的設備上,以他們選擇的語言,向正確的人,提供正確的內容。
舉一個DITA的例子:
<conbody><p>剎車片</p><p level="Lite">剎車片也叫剎車皮。在汽車的剎車系統中,剎車片是最關鍵的安全零件,剎車效果的好壞都是剎車片起決定性作用</p><p level="Professional"> 剎車片(brake lining)一般由鋼板、粘接隔熱層和摩擦塊構成,鋼板要經過涂裝來防銹,涂裝過程用SMT-4爐溫跟蹤儀來檢測涂裝過程的溫度分布來保證質量。其中隔熱層是由不傳熱的材料組成,目的是隔熱。摩擦塊由摩擦材料、粘合劑組成,剎車時被擠壓在剎車盤或剎車鼓上產生摩擦,從而達到車輛減速剎車的目的。由于摩擦作用,摩擦塊會逐漸被磨損,一般來講成本越低的剎車片磨損得越快。</p> </conbody>內容中第一段沒有屬性;第二段level的屬性是Lite,表示一般簡介;第三段level的屬性是Profesional,是專業的內容。
在出版的時候,可以發布兩個版本的文檔。一個是給一般用戶的簡要版和一個給專業用戶的專業版。簡要版只包括第一和二段(簡要介紹)。專業版包括?第一,二和三段(不僅包括簡要介紹,還包括原理)。
二、DITA與S1000D的不同點
DITA最初由IBM公司設計,用于編寫IBM公司產品的文檔。DITA是Darwin Information Typing Architecture(達爾文信息類型架構)的縮寫,達爾文是英國生物學家,進化論的奠基人。DITA正是因為使用類似于達爾文的進化適應概念而得名。它不預設使用行業,而是設計用來被擴展。
正是因為DITA這種可擴展性的設計,獲得了不同領域的采納。被用于編寫各行業的各種文檔,如:交互式培訓和教育材料、標準、報告、商業文檔、商業書籍、旅游和自然指南等。
S1000D最初是由歐洲航空工業聯盟開發的技術出版物規范,它主要為具有較長生命的復雜產品運行和維修而設計。這些年不斷發展,已經擴展到這些行業的產品:國防系統 – 包括海、陸、空的產品,民用航空產品,基建行業產品和船舶工業產品。
因為不同的需求、不同的設計者,導致兩個規范的不同。
1. DITA提供一個框架,不限定行業,用于被擴展;S1000D則非常具體,大而全
DITA提供基礎架構和通用的信息類型,規范精簡。DITA自帶四個主題信息類型:Topic, Concept, Task, Reference。這些信息類型都通用的,沒有針對具體場景提供具有語義的規定。使用者根據自己的需求來擴展DITA實現自己的文檔類型(雖然DITA的信息類型已經能夠滿足很多通用文檔的需求)。
S1000D是根據具體的需求設計,涵蓋所述行業的所有需求,并且不支持擴展。信息類型包括:說明(Description), 程序(Procedural), 維修計劃(Maintenance schedules), 故障隔離(Fault Isolation)等。
從兩個規范的PDF大小也能看出這種區別。DITA規范的核心內容有200頁;S1000D規范的核心則有3000頁。
為什么會有這種區別呢?
復雜產品一般有很長的供應鏈。拿波音飛機來說,它的零部件由分布在70多個國家的近 600家供應商生產。這些供應商需要交換產品的使用和維修信息。他們需要統一的語言來進行這種數據交換,這個語言就是S1000D。實施一個S1000D項目的第一項工作是制定業務規則(Business Rule)來在S1000D的基礎上縮減范圍、限制某些 XML 元素的使用。項目中不需要修改S1000D的Schema。供應鏈上下游的企業都使用統一的業務規則來進行數據生成和交換。
DITA規范不是設計用來進行數據交換的。一般是將發布以后的結果交給內部或者外部的讀者使用,不交換XML數據。實施一個DITA項目,通常第一件事是根據企業的需求,通過專有化機制來設計信息類型,這會增加新的XML元素。
2. S1000D不僅是數據規范,而且規定文檔的整個過程
DITA規范是一個數據規范。
S1000D規范不僅是數據規范,它覆蓋技術出版物的整個過程。它不僅包括用于實際內容創作的XML Schema,而且涵蓋了更多內容,如數據交換、質量保證、版本控制、基于頁面和電子格式的展現等。
3. S1000D定義了編碼系統
S1000D中,每個數據模塊有唯一編號,編號中使用標準編號系統(SNS)和信息代碼,編號中的數字有具體的意義。SNS描述數據模塊涉及的是產品的哪個組件,而信息代碼會描述數據模塊包含的關于該組件的哪些信息。
例如,SNS 32-00-00表示“起落架”,信息代碼040表示“說明”,則會得到標題為“起落架-說明”的數據模塊“DMC-PLANE-32-00-00-00A-040A-D”。
4. DITA 支持專有化
DITA被設計用來根據具體需求擴展,它的機制就是專有化(Speciailization)。DITA的專門化特性允許創建新的元素類型和屬性,這些類型和屬性是從現有類型派生的。
它跟面向對象編程的思路相似,主題 (Topic)相當基類,我們可以繼承主題,來定義不同的子類。
從這個角度能看出DITA是計算機專家設計出來的。
三、各自的應用場景
通過以上分析,我們可以看出S1000D適合用于具有較長生命的復雜產品的手冊和數據交換。目前包含:
- 國防系統 – 包括海、陸、空的產品
- 民用航空產品
- 基建行業產品
- 船舶工業產品
相較而言,DITA更加靈活,輕量,并不限應用的行業。它適合用于不需要在企業之間進行數據交換的情形。
更多S1000D和DITA的內容,請見:www.manualsware.com
總結
以上是生活随笔為你收集整理的DITA与S1000D的相同与不同的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: NFRE-解析下载数据包
- 下一篇: Laravel Debugbar