文檔修訂控制第 4 部分:創(chuàng)作流程和技巧
Date: 2020-09-17 15:32:17Source: 志遠翻譯
文件翻譯
在我的文檔修訂控制博客文章系列的這一部分,我將描述在整個創(chuàng)作過程中關(guān)于修訂控制需要考慮的一些事情。我還會給您一些關(guān)于版本控制和記錄您的策略與程序的額外提示。
在整個創(chuàng)作過程中管理修訂控制
在之前的博客文章中,我談到了版本控制的要素,例如管理文檔版本、創(chuàng)建標準文件夾目錄結(jié)構(gòu)、跟蹤版本之間的變化以及建立零件號和文件命名約定。以下的內(nèi)容可以讓您一瞥如何在整個創(chuàng)作過程中實施這些準則。
啟動新項目
如果您要創(chuàng)建新文檔或修改現(xiàn)有文檔,請遵循您建立的文檔部分命名規(guī)則和文件命名規(guī)則。您還需要設(shè)置好文件夾目錄結(jié)構(gòu)。
在審核周期中管理文檔
在審閱周期中,您不希望審閱者認為文檔是最終草稿,并將其保存下來以供重用。為了防止這種情況發(fā)生,您需要在文檔上創(chuàng)建某種明顯的標識符,以反映這份文檔是草稿。您可以使用 Adobe Acrobat 添加水印或圖章。您也可以使用您的寫作工具提供的任何功能。
對于評審者來說,了解修訂之間的變化是很有幫助的,這樣他們就知道應(yīng)該關(guān)注什么,尤其是如果是一份很長的技術(shù)性文檔。
您應(yīng)該在審閱周期內(nèi)為文檔建立一個命名系統(tǒng),尤其是如果您通常有多個審閱周期。這個步驟很簡單,比如可以在文件名中添加 V1、V2 這樣或者 1、2、3 等文件版本號。例如:
ABC_ 快速入門 _ 英語 _10036_V1
您還應(yīng)當創(chuàng)建一個文件目錄文件夾來存儲草稿。
最終確定并發(fā)布文檔
確定誰負責保存最終文件以及文件應(yīng)存放在哪里,并遵循標準章節(jié)號和文件命名系統(tǒng)。您還要決定如何處理草稿。
其他人可能需要將文檔上傳到網(wǎng)站、打印或通過配置管理發(fā)布。如果是這樣,請確保您與這些人員建立了一個流程,這樣在其他文件夾或其他地方就不會有多個版本的文檔可用??紤]創(chuàng)建一個核對表,包括所有過程和步驟。
打印紙質(zhì)副本
如果您為內(nèi)部團隊(如客戶服務(wù)團隊)打印紙質(zhì)副本,請記錄它們所在的位置,并建立一個流程,以便在發(fā)布新版本或新文檔時更新它們。
提供溝通計劃
創(chuàng)建內(nèi)部和外部溝通計劃,讓您的客戶知道文檔已經(jīng)更新或創(chuàng)建出來了。如果合適的話,對于修訂版,要說明有什么變化。
遵循翻譯文件的標準程序
如果您翻譯文檔,請使用文件命名系統(tǒng)并確定主文檔的存儲位置。此外,請遵循本節(jié)中適用于翻譯文檔的任何流程。
管理文檔的技巧
以下是我推薦的其他一些東西,可以幫助您管理版本控制過程。
創(chuàng)建文檔主列表
創(chuàng)建所有文檔的主列表,包括標題、章節(jié)號、修訂字母、語言和您可能想要搜索的任何其他信息。擁有一個可以搜索和參考的列表將有助于您管理文檔和處理文件清單。這將提供文檔集的整體視圖,您可以參考當前版本并管理語言支持。此外,如果產(chǎn)品中有什么變化,您可以很容易地看到哪些文檔可能會受到影響。
記錄政策和程序
我建議寫下您所有的修訂控制政策和程序,供團隊遵循。忘記細節(jié)是很容易的,尤其是當您新進入一個項目的時候,所以有一個參考是有幫助的。當新作家加入時,這將幫助他們學(xué)習這個系統(tǒng),而不需要花費太多的訓(xùn)練時間。
創(chuàng)建文檔報廢計劃
我還建議為發(fā)布的文檔建立一個文檔淘汰計劃和定期審查周期,并將這些納入您的政策和程序文檔中。我們經(jīng)常忙于關(guān)注即將發(fā)生的事情,以至于忘記了已經(jīng)為為顧客們提供的文檔。然而,如果您的網(wǎng)站上有過時或錯誤的內(nèi)容,它們都會變成一種隱患。顧客可能會抱怨并開始懷疑您提供的信息,這可能最終會傷害顧客忠誠度或勸阻潛在的新顧客,而且還可能產(chǎn)生一定的法律后果。建立并遵循文件廢棄計劃和審查周期,便可以確保您所掌握的信息是最新的和正確的。
結(jié)論
在整個創(chuàng)作過程中,有許多方法可以管理版本控制。記錄您的政策和程序?qū)⒂兄诒3忠恢滦?。請在我的博客中尋找關(guān)于 Adobe FrameMaker 中修訂控制功能的文章。
文件翻譯
在我的文檔修訂控制博客文章系列的這一部分,我將描述在整個創(chuàng)作過程中關(guān)于修訂控制需要考慮的一些事情。我還會給您一些關(guān)于版本控制和記錄您的策略與程序的額外提示。
在整個創(chuàng)作過程中管理修訂控制
在之前的博客文章中,我談到了版本控制的要素,例如管理文檔版本、創(chuàng)建標準文件夾目錄結(jié)構(gòu)、跟蹤版本之間的變化以及建立零件號和文件命名約定。以下的內(nèi)容可以讓您一瞥如何在整個創(chuàng)作過程中實施這些準則。
啟動新項目
如果您要創(chuàng)建新文檔或修改現(xiàn)有文檔,請遵循您建立的文檔部分命名規(guī)則和文件命名規(guī)則。您還需要設(shè)置好文件夾目錄結(jié)構(gòu)。
在審核周期中管理文檔
在審閱周期中,您不希望審閱者認為文檔是最終草稿,并將其保存下來以供重用。為了防止這種情況發(fā)生,您需要在文檔上創(chuàng)建某種明顯的標識符,以反映這份文檔是草稿。您可以使用 Adobe Acrobat 添加水印或圖章。您也可以使用您的寫作工具提供的任何功能。
對于評審者來說,了解修訂之間的變化是很有幫助的,這樣他們就知道應(yīng)該關(guān)注什么,尤其是如果是一份很長的技術(shù)性文檔。
您應(yīng)該在審閱周期內(nèi)為文檔建立一個命名系統(tǒng),尤其是如果您通常有多個審閱周期。這個步驟很簡單,比如可以在文件名中添加 V1、V2 這樣或者 1、2、3 等文件版本號。例如:
ABC_ 快速入門 _ 英語 _10036_V1
您還應(yīng)當創(chuàng)建一個文件目錄文件夾來存儲草稿。
最終確定并發(fā)布文檔
確定誰負責保存最終文件以及文件應(yīng)存放在哪里,并遵循標準章節(jié)號和文件命名系統(tǒng)。您還要決定如何處理草稿。
其他人可能需要將文檔上傳到網(wǎng)站、打印或通過配置管理發(fā)布。如果是這樣,請確保您與這些人員建立了一個流程,這樣在其他文件夾或其他地方就不會有多個版本的文檔可用??紤]創(chuàng)建一個核對表,包括所有過程和步驟。
打印紙質(zhì)副本
如果您為內(nèi)部團隊(如客戶服務(wù)團隊)打印紙質(zhì)副本,請記錄它們所在的位置,并建立一個流程,以便在發(fā)布新版本或新文檔時更新它們。
提供溝通計劃
創(chuàng)建內(nèi)部和外部溝通計劃,讓您的客戶知道文檔已經(jīng)更新或創(chuàng)建出來了。如果合適的話,對于修訂版,要說明有什么變化。
遵循翻譯文件的標準程序
如果您翻譯文檔,請使用文件命名系統(tǒng)并確定主文檔的存儲位置。此外,請遵循本節(jié)中適用于翻譯文檔的任何流程。
管理文檔的技巧
以下是我推薦的其他一些東西,可以幫助您管理版本控制過程。
創(chuàng)建文檔主列表
創(chuàng)建所有文檔的主列表,包括標題、章節(jié)號、修訂字母、語言和您可能想要搜索的任何其他信息。擁有一個可以搜索和參考的列表將有助于您管理文檔和處理文件清單。這將提供文檔集的整體視圖,您可以參考當前版本并管理語言支持。此外,如果產(chǎn)品中有什么變化,您可以很容易地看到哪些文檔可能會受到影響。
記錄政策和程序
我建議寫下您所有的修訂控制政策和程序,供團隊遵循。忘記細節(jié)是很容易的,尤其是當您新進入一個項目的時候,所以有一個參考是有幫助的。當新作家加入時,這將幫助他們學(xué)習這個系統(tǒng),而不需要花費太多的訓(xùn)練時間。
創(chuàng)建文檔報廢計劃
我還建議為發(fā)布的文檔建立一個文檔淘汰計劃和定期審查周期,并將這些納入您的政策和程序文檔中。我們經(jīng)常忙于關(guān)注即將發(fā)生的事情,以至于忘記了已經(jīng)為為顧客們提供的文檔。然而,如果您的網(wǎng)站上有過時或錯誤的內(nèi)容,它們都會變成一種隱患。顧客可能會抱怨并開始懷疑您提供的信息,這可能最終會傷害顧客忠誠度或勸阻潛在的新顧客,而且還可能產(chǎn)生一定的法律后果。建立并遵循文件廢棄計劃和審查周期,便可以確保您所掌握的信息是最新的和正確的。
結(jié)論
在整個創(chuàng)作過程中,有許多方法可以管理版本控制。記錄您的政策和程序?qū)⒂兄诒3忠恢滦?。請在我的博客中尋找關(guān)于 Adobe FrameMaker 中修訂控制功能的文章。
文件翻譯
The End