技術(shù)文檔 | 如何編寫對(duì)外的發(fā)版說明

寫在前面

在技術(shù)文檔寫作過程中,通常需要技術(shù)文檔工程師收集并整理匯總產(chǎn)品當(dāng)前版本中包括什么功能,即,發(fā)版說明(又稱,ReleaseNotes),那么應(yīng)該怎么編寫呢?下文根據(jù)個(gè)人經(jīng)驗(yàn),總結(jié)以下內(nèi)容,供大家參考。

內(nèi)容要點(diǎn)

內(nèi)容主要包含本次發(fā)版的產(chǎn)品的某一功能或特性

  • 發(fā)生了什么變化?
  • 為什么變了?
  • 用戶如何受到影響?
  • 用戶現(xiàn)在需要做什么?

編寫規(guī)則

  • 專注于對(duì)客戶的價(jià)值
  • 使用簡(jiǎn)單的語言

編寫方法

編寫方法一般情況下有如下兩種方式:

● 從feature的角度寫。通常當(dāng)該feature (如新改進(jìn)New UI或 New settings等)很難通過三言兩語說清對(duì)核心讀者的Benefit就只寫提供什么new changes,或者,該feature達(dá)到的目的不是用戶take action就能實(shí)現(xiàn)的,才選擇此種方法。突出新Item的特性或是陳述新feature

● 從用戶操作的角度寫。以核心讀者(你)為核心,該新的feature可以讓你直接完成哪些“以前”不能做的事,你可以直接通過很直接的界面操作,達(dá)到目的。

[功能點(diǎn)] + [功能描述/功能價(jià)值點(diǎn)/benefit]

編寫樣例

編寫樣例大綱
編寫樣例

寫在后面

發(fā)版說明的編寫需要根據(jù)不同產(chǎn)品發(fā)布的特點(diǎn)及受眾群體的特點(diǎn),決定是偏清晰描述還是偏概括抽象。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡(jiǎn)書系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容