文檔修訂控制第 4 部分:創(chuàng)作流程和技巧
Date: 2020-09-17 15:32:17Source: 志遠(yuǎn)翻譯
文件翻譯
在我的文檔修訂控制博客文章系列的這一部分,我將描述在整個(gè)創(chuàng)作過程中關(guān)于修訂控制需要考慮的一些事情科普活動。我還會(huì)給您一些關(guān)于版本控制和記錄您的策略與程序的額外提示。
在整個(gè)創(chuàng)作過程中管理修訂控制
在之前的博客文章中強化意識,我談到了版本控制的要素長期間,例如管理文檔版本、創(chuàng)建標(biāo)準(zhǔn)文件夾目錄結(jié)構(gòu)現場、跟蹤版本之間的變化以及建立零件號(hào)和文件命名約定高端化。以下的內(nèi)容可以讓您一瞥如何在整個(gè)創(chuàng)作過程中實(shí)施這些準(zhǔn)則。
啟動(dòng)新項(xiàng)目
如果您要?jiǎng)?chuàng)建新文檔或修改現(xiàn)有文檔不久前,請(qǐng)遵循您建立的文檔部分命名規(guī)則和文件命名規(guī)則用上了。您還需要設(shè)置好文件夾目錄結(jié)構(gòu)。
在審核周期中管理文檔
在審閱周期中能力建設,您不希望審閱者認(rèn)為文檔是最終草稿關註,并將其保存下來以供重用。為了防止這種情況發(fā)生無障礙,您需要在文檔上創(chuàng)建某種明顯的標(biāo)識(shí)符連日來,以反映這份文檔是草稿。您可以使用 Adobe Acrobat 添加水印或圖章認為。您也可以使用您的寫作工具提供的任何功能系統。
對(duì)于評(píng)審者來說,了解修訂之間的變化是很有幫助的更合理,這樣他們就知道應(yīng)該關(guān)注什么適應能力,尤其是如果是一份很長(zhǎng)的技術(shù)性文檔。
您應(yīng)該在審閱周期內(nèi)為文檔建立一個(gè)命名系統(tǒng),尤其是如果您通常有多個(gè)審閱周期防控。這個(gè)步驟很簡(jiǎn)單成效與經驗,比如可以在文件名中添加 V1、V2 這樣或者 1堅實基礎、2稍有不慎、3 等文件版本號(hào)。例如:
ABC_ 快速入門 _ 英語 _10036_V1
您還應(yīng)當(dāng)創(chuàng)建一個(gè)文件目錄文件夾來存儲(chǔ)草稿等地。
最終確定并發(fā)布文檔
確定誰負(fù)責(zé)保存最終文件以及文件應(yīng)存放在哪里最為顯著,并遵循標(biāo)準(zhǔn)章節(jié)號(hào)和文件命名系統(tǒng)。您還要決定如何處理草稿規定。
其他人可能需要將文檔上傳到網(wǎng)站環境、打印或通過配置管理發(fā)布。如果是這樣供給,請(qǐng)確保您與這些人員建立了一個(gè)流程優勢與挑戰,這樣在其他文件夾或其他地方就不會(huì)有多個(gè)版本的文檔可用〗鉀Q方案?紤]創(chuàng)建一個(gè)核對(duì)表趨勢,包括所有過程和步驟。
打印紙質(zhì)副本
如果您為內(nèi)部團(tuán)隊(duì)(如客戶服務(wù)團(tuán)隊(duì))打印紙質(zhì)副本上高質量,請(qǐng)記錄它們所在的位置一站式服務,并建立一個(gè)流程,以便在發(fā)布新版本或新文檔時(shí)更新它們深入交流。
提供溝通計(jì)劃
創(chuàng)建內(nèi)部和外部溝通計(jì)劃引領作用,讓您的客戶知道文檔已經(jīng)更新或創(chuàng)建出來了。如果合適的話臺上與臺下,對(duì)于修訂版用的舒心,要說明有什么變化。
遵循翻譯文件的標(biāo)準(zhǔn)程序
如果您翻譯文檔集聚效應,請(qǐng)使用文件命名系統(tǒng)并確定主文檔的存儲(chǔ)位置集成。此外,請(qǐng)遵循本節(jié)中適用于翻譯文檔的任何流程確定性。
管理文檔的技巧
以下是我推薦的其他一些東西更加廣闊,可以幫助您管理版本控制過程。
創(chuàng)建文檔主列表
創(chuàng)建所有文檔的主列表講故事,包括標(biāo)題非常完善、章節(jié)號(hào)、修訂字母全面革新、語言和您可能想要搜索的任何其他信息作用。擁有一個(gè)可以搜索和參考的列表將有助于您管理文檔和處理文件清單情況正常。這將提供文檔集的整體視圖,您可以參考當(dāng)前版本并管理語言支持發揮重要作用。此外醒悟,如果產(chǎn)品中有什么變化,您可以很容易地看到哪些文檔可能會(huì)受到影響高質量。
記錄政策和程序
我建議寫下您所有的修訂控制政策和程序,供團(tuán)隊(duì)遵循記得牢。忘記細(xì)節(jié)是很容易的註入了新的力量,尤其是當(dāng)您新進(jìn)入一個(gè)項(xiàng)目的時(shí)候,所以有一個(gè)參考是有幫助的更多可能性。當(dāng)新作家加入時(shí)去創新,這將幫助他們學(xué)習(xí)這個(gè)系統(tǒng),而不需要花費(fèi)太多的訓(xùn)練時(shí)間緊迫性。
創(chuàng)建文檔報(bào)廢計(jì)劃
我還建議為發(fā)布的文檔建立一個(gè)文檔淘汰計(jì)劃和定期審查周期結構,并將這些納入您的政策和程序文檔中。我們經(jīng)常忙于關(guān)注即將發(fā)生的事情高效,以至于忘記了已經(jīng)為為顧客們提供的文檔溝通協調。然而,如果您的網(wǎng)站上有過時(shí)或錯(cuò)誤的內(nèi)容體系,它們都會(huì)變成一種隱患保障性。顧客可能會(huì)抱怨并開始懷疑您提供的信息,這可能最終會(huì)傷害顧客忠誠度或勸阻潛在的新顧客責任製,而且還可能產(chǎn)生一定的法律后果十分落實。建立并遵循文件廢棄計(jì)劃和審查周期,便可以確保您所掌握的信息是最新的和正確的規則製定。
結(jié)論
在整個(gè)創(chuàng)作過程中製造業,有許多方法可以管理版本控制。記錄您的政策和程序?qū)⒂兄诒3忠恢滦詧远ú灰?。?qǐng)?jiān)谖业牟┛椭袑ふ谊P(guān)于 Adobe FrameMaker 中修訂控制功能的文章組合運用。
文件翻譯
在我的文檔修訂控制博客文章系列的這一部分,我將描述在整個(gè)創(chuàng)作過程中關(guān)于修訂控制需要考慮的一些事情科普活動。我還會(huì)給您一些關(guān)于版本控制和記錄您的策略與程序的額外提示。
在整個(gè)創(chuàng)作過程中管理修訂控制
在之前的博客文章中強化意識,我談到了版本控制的要素長期間,例如管理文檔版本、創(chuàng)建標(biāo)準(zhǔn)文件夾目錄結(jié)構(gòu)現場、跟蹤版本之間的變化以及建立零件號(hào)和文件命名約定高端化。以下的內(nèi)容可以讓您一瞥如何在整個(gè)創(chuàng)作過程中實(shí)施這些準(zhǔn)則。
啟動(dòng)新項(xiàng)目
如果您要?jiǎng)?chuàng)建新文檔或修改現(xiàn)有文檔不久前,請(qǐng)遵循您建立的文檔部分命名規(guī)則和文件命名規(guī)則用上了。您還需要設(shè)置好文件夾目錄結(jié)構(gòu)。
在審核周期中管理文檔
在審閱周期中能力建設,您不希望審閱者認(rèn)為文檔是最終草稿關註,并將其保存下來以供重用。為了防止這種情況發(fā)生無障礙,您需要在文檔上創(chuàng)建某種明顯的標(biāo)識(shí)符連日來,以反映這份文檔是草稿。您可以使用 Adobe Acrobat 添加水印或圖章認為。您也可以使用您的寫作工具提供的任何功能系統。
對(duì)于評(píng)審者來說,了解修訂之間的變化是很有幫助的更合理,這樣他們就知道應(yīng)該關(guān)注什么適應能力,尤其是如果是一份很長(zhǎng)的技術(shù)性文檔。
您應(yīng)該在審閱周期內(nèi)為文檔建立一個(gè)命名系統(tǒng),尤其是如果您通常有多個(gè)審閱周期防控。這個(gè)步驟很簡(jiǎn)單成效與經驗,比如可以在文件名中添加 V1、V2 這樣或者 1堅實基礎、2稍有不慎、3 等文件版本號(hào)。例如:
ABC_ 快速入門 _ 英語 _10036_V1
您還應(yīng)當(dāng)創(chuàng)建一個(gè)文件目錄文件夾來存儲(chǔ)草稿等地。
最終確定并發(fā)布文檔
確定誰負(fù)責(zé)保存最終文件以及文件應(yīng)存放在哪里最為顯著,并遵循標(biāo)準(zhǔn)章節(jié)號(hào)和文件命名系統(tǒng)。您還要決定如何處理草稿規定。
其他人可能需要將文檔上傳到網(wǎng)站環境、打印或通過配置管理發(fā)布。如果是這樣供給,請(qǐng)確保您與這些人員建立了一個(gè)流程優勢與挑戰,這樣在其他文件夾或其他地方就不會(huì)有多個(gè)版本的文檔可用〗鉀Q方案?紤]創(chuàng)建一個(gè)核對(duì)表趨勢,包括所有過程和步驟。
打印紙質(zhì)副本
如果您為內(nèi)部團(tuán)隊(duì)(如客戶服務(wù)團(tuán)隊(duì))打印紙質(zhì)副本上高質量,請(qǐng)記錄它們所在的位置一站式服務,并建立一個(gè)流程,以便在發(fā)布新版本或新文檔時(shí)更新它們深入交流。
提供溝通計(jì)劃
創(chuàng)建內(nèi)部和外部溝通計(jì)劃引領作用,讓您的客戶知道文檔已經(jīng)更新或創(chuàng)建出來了。如果合適的話臺上與臺下,對(duì)于修訂版用的舒心,要說明有什么變化。
遵循翻譯文件的標(biāo)準(zhǔn)程序
如果您翻譯文檔集聚效應,請(qǐng)使用文件命名系統(tǒng)并確定主文檔的存儲(chǔ)位置集成。此外,請(qǐng)遵循本節(jié)中適用于翻譯文檔的任何流程確定性。
管理文檔的技巧
以下是我推薦的其他一些東西更加廣闊,可以幫助您管理版本控制過程。
創(chuàng)建文檔主列表
創(chuàng)建所有文檔的主列表講故事,包括標(biāo)題非常完善、章節(jié)號(hào)、修訂字母全面革新、語言和您可能想要搜索的任何其他信息作用。擁有一個(gè)可以搜索和參考的列表將有助于您管理文檔和處理文件清單情況正常。這將提供文檔集的整體視圖,您可以參考當(dāng)前版本并管理語言支持發揮重要作用。此外醒悟,如果產(chǎn)品中有什么變化,您可以很容易地看到哪些文檔可能會(huì)受到影響高質量。
記錄政策和程序
我建議寫下您所有的修訂控制政策和程序,供團(tuán)隊(duì)遵循記得牢。忘記細(xì)節(jié)是很容易的註入了新的力量,尤其是當(dāng)您新進(jìn)入一個(gè)項(xiàng)目的時(shí)候,所以有一個(gè)參考是有幫助的更多可能性。當(dāng)新作家加入時(shí)去創新,這將幫助他們學(xué)習(xí)這個(gè)系統(tǒng),而不需要花費(fèi)太多的訓(xùn)練時(shí)間緊迫性。
創(chuàng)建文檔報(bào)廢計(jì)劃
我還建議為發(fā)布的文檔建立一個(gè)文檔淘汰計(jì)劃和定期審查周期結構,并將這些納入您的政策和程序文檔中。我們經(jīng)常忙于關(guān)注即將發(fā)生的事情高效,以至于忘記了已經(jīng)為為顧客們提供的文檔溝通協調。然而,如果您的網(wǎng)站上有過時(shí)或錯(cuò)誤的內(nèi)容體系,它們都會(huì)變成一種隱患保障性。顧客可能會(huì)抱怨并開始懷疑您提供的信息,這可能最終會(huì)傷害顧客忠誠度或勸阻潛在的新顧客責任製,而且還可能產(chǎn)生一定的法律后果十分落實。建立并遵循文件廢棄計(jì)劃和審查周期,便可以確保您所掌握的信息是最新的和正確的規則製定。
結(jié)論
在整個(gè)創(chuàng)作過程中製造業,有許多方法可以管理版本控制。記錄您的政策和程序?qū)⒂兄诒3忠恢滦詧远ú灰?。?qǐng)?jiān)谖业牟┛椭袑ふ谊P(guān)于 Adobe FrameMaker 中修訂控制功能的文章組合運用。
文件翻譯
The End