BS EN 2782-10是一種技術(shù)標(biāo)準(zhǔn),它指定了航空航天行業(yè)編寫和格式化技術(shù)文檔的要求。它涵蓋了各個(gè)方面,包括文檔結(jié)構(gòu),內(nèi)容,語(yǔ)言和演示。
了解文檔結(jié)構(gòu)
BS EN 2782-10定義了技術(shù)文檔的清晰邏輯結(jié)構(gòu)。它突出了擁有標(biāo)題頁(yè),目錄以及圖形和表列表的重要性。這些元素可幫助讀者有效地瀏覽文檔并找到特定的信息。
此外,標(biāo)準(zhǔn)強(qiáng)調(diào)了需要清晰的標(biāo)題和子標(biāo)題來(lái)組織內(nèi)容的必要性。這使讀者更容易找到相關(guān)部分并了解文檔的整體流程。
內(nèi)容要求
除了結(jié)構(gòu)指南外,BS EN 2782-10概述了技術(shù)文檔的內(nèi)容要求。它強(qiáng)調(diào)提供準(zhǔn)確和最新信息的重要性。技術(shù)作家應(yīng)確保以簡(jiǎn)潔的方式對(duì)內(nèi)容進(jìn)行充分研究,驗(yàn)證和介紹。
此外,該標(biāo)準(zhǔn)可以鼓勵(lì)使用圖形表示,例如圖表,圖表和插圖來(lái)增強(qiáng)理解。這些視覺效果應(yīng)在文本中適當(dāng)標(biāo)記和引用。
語(yǔ)言和演示
BS EN 2782-10還介紹了技術(shù)文檔的語(yǔ)言和演示方面。它促進(jìn)了普通語(yǔ)言的使用,避免了可能混淆或疏遠(yuǎn)讀者的不必要的行話或技術(shù)術(shù)語(yǔ)。該文檔應(yīng)盡可能使用主動(dòng)語(yǔ)態(tài)以清晰簡(jiǎn)潔的方式編寫。
此外,該標(biāo)準(zhǔn)還指定表,圖形和方程式的格式,以確保整個(gè)文檔中的一致性。適當(dāng)?shù)囊煤蛥⒖技夹g(shù)(按照公認(rèn)的標(biāo)準(zhǔn))也被強(qiáng)調(diào),以提高文檔的信譽(yù)。
總之,BS EN 2782-10是航空航天行業(yè)的技術(shù)作家的寶貴指南。通過(guò)遵守其準(zhǔn)則,文檔可以變得更加有條理,信息豐富且讀者可以訪問(wèn)。它提供了一個(gè)框架來(lái)創(chuàng)建符合行業(yè)標(biāo)準(zhǔn)的清晰,準(zhǔn)確,結(jié)構(gòu)良好的技術(shù)文檔。
聯(lián)系人:李生
手機(jī):13751010017
電話:0755-33168386
地址: 廣東省深圳市寶安區(qū)西鄉(xiāng)大道與寶安大道交匯處寶和大廈6F