利用軟件工具提高技術(shù)文檔寫(xiě)作質(zhì)量和效率方法的研究.pdf

1、軟件行業(yè)的技術(shù)文檔寫(xiě)作是連接用戶和復(fù)雜抽象的軟件產(chǎn)品的橋梁，提高了軟件產(chǎn)品的易用性，是軟件產(chǎn)品不可缺失的一部分。本文旨在研究如何利用軟件工具提高技術(shù)文檔寫(xiě)作效率和提升技術(shù)文檔寫(xiě)作質(zhì)量從而提高軟件的易用性。
　　本文首先分析了技術(shù)文檔的質(zhì)量特性，歸納為任務(wù)導(dǎo)向性、準(zhǔn)確性、完整性、清晰性、具體性、風(fēng)格統(tǒng)一性、視覺(jué)有效性和易檢索性，這八點(diǎn)是衡量技術(shù)文檔質(zhì)量的標(biāo)準(zhǔn)。
　　本文研究了利用軟件工具分離源文件和可交付文檔，克服了所見(jiàn)即所得

2、軟件編輯技術(shù)文檔的弊端，通過(guò)語(yǔ)法分析器將存儲(chǔ)技術(shù)文檔內(nèi)容的源文件轉(zhuǎn)換為多種形式的可交付技術(shù)文檔，并驗(yàn)證了利用軟件工具的效果。還對(duì)產(chǎn)品集源文件的整體管理進(jìn)行研究利用軟件工具整體管理產(chǎn)品集源文克服分散管理產(chǎn)品集源文件的弊端件，通過(guò)案例驗(yàn)證了有效的源文件管理對(duì)于產(chǎn)品集源文件的整體管理的重要意義。
　　本文還研究如何使用自動(dòng)化工具完成技術(shù)文檔寫(xiě)作中重復(fù)性和機(jī)械性的操作，主要包括技術(shù)文檔語(yǔ)言檢查、索引條目整體管理、內(nèi)容可用性檢查、其他文檔格

3、式向DITA格式進(jìn)行遷移。通過(guò)案例研究和用戶調(diào)研，證明這些軟件工具和方法能協(xié)助技術(shù)文檔工程師克服資源的限制，高效率和高質(zhì)量地交付技術(shù)文檔。
　　除此之外，本文還研究了技術(shù)文檔表現(xiàn)形式，傳統(tǒng)的技術(shù)文檔表現(xiàn)形式的不足之處在于只能呈現(xiàn)靜態(tài)信息，即難以提供有針對(duì)性和個(gè)性化的內(nèi)容。為了提升用戶體驗(yàn)，本文研究了基于XML編碼的互動(dòng)式文檔模式的表現(xiàn)方式和實(shí)現(xiàn)方法，通過(guò)案例實(shí)踐和用戶調(diào)研，收集了關(guān)于傳統(tǒng)靜態(tài)文檔和互動(dòng)式文檔的用戶反饋，并驗(yàn)證了互動(dòng)