如果你有一個簡單的場景,比如在微軟Word中創(chuàng)建一封信,那么結(jié)構(gòu)化寫作不一定依賴工具,而不是寫程序。然而,結(jié)構(gòu)化寫作通常用于更復(fù)雜的場景,例如,如果您在基于XML的編輯器(如XMetaL)中創(chuàng)建數(shù)百個主題。因為有各種各樣的場景,所以我將把重點放在結(jié)構(gòu)化編寫上,因為它適合重用使用DITA用XML編寫的技術(shù)內(nèi)容,這需要工具。在這種情況下,我將在較高層次上討論所需的五個主要工具。
1.XML創(chuàng)作工具
您需要一個XML創(chuàng)作和編輯工具,比如oXygen XML編輯器、XMetaL或Arbortext編輯器。這些工具有一系列的功能和許可結(jié)構(gòu)。
編寫架構(gòu)
DITA(達爾文信息分類體系結(jié)構(gòu))是一個具有結(jié)構(gòu)化內(nèi)容的開放體系結(jié)構(gòu)。它允許您用預(yù)定義的元素標記內(nèi)容的所有組件。雖然總的來說有許多不同的元素,但主題的主要元素是任務(wù)、概念和參考。例如,我在上一篇關(guān)于結(jié)構(gòu)化寫作的博文中使用的主題“如何驗證包內(nèi)容”就是一個任務(wù)元素。要使用DITA,您需要首先檢查您的內(nèi)容,然后查看它是否符合標準。當內(nèi)容不適合架構(gòu)時,也可以使用變體。盡管還有其他內(nèi)容模型,DITA是最常用的技術(shù)編寫標準,而XML創(chuàng)作工具支持DITA。
3.文檔類型定義(Document Type Definition的縮寫)
每條指令都需要一個標題。
步驟必須編號。
如果我們編寫一個像下面這樣的任務(wù),并使用段落描述,DTD將識別出格式不正確,您將收到一個錯誤:
如何驗證包裝內(nèi)容
打開箱子,找到裝箱單。確保內(nèi)容匹配。
DTD在開發(fā)內(nèi)容時驗證結(jié)構(gòu),因此您將無法執(zhí)行任何不適合該結(jié)構(gòu)的操作。DTD附帶了標準的XML創(chuàng)作工具。您也可以創(chuàng)建自己的或修改現(xiàn)有的,如果您有專業(yè)知識,您可能會想這樣做。
4.樣式表(XSLT)
樣式表或XSLT(可擴展樣式表語言轉(zhuǎn)換)
定義每個元素的格式和輸出類型。標準的XML創(chuàng)作工具帶有樣式表,但是您可能希望修改它們以包括公司的風(fēng)格標準。例如,如果您想將編號步驟的字體更改為Calibri 11磅,您可以在樣式表中定義它。
5.組件內(nèi)容管理系統(tǒng)
與獨立文檔不同,以XML格式創(chuàng)建的文檔可能包含數(shù)十或數(shù)百個較小的XML文件,這些文件通過創(chuàng)建DITA映射來匯總。所有這些小XML文件都需要在組件內(nèi)容管理系統(tǒng)(CCMS)中存儲和管理。每個文件都可以在許多不同的文檔和輸出中重用。CCMS管理每個文件的生命周期。有許多不同功能和成本的CCMS選項。
結(jié)論
結(jié)構(gòu)化XML編寫中使用的五個主要工具是XML編寫工具、DITA編寫架構(gòu)、DTD、樣式表和內(nèi)容管理工具。在本系列的下一篇博文中,我將詳細解釋如何使用DITA創(chuàng)建可重用的內(nèi)容。
