發行說明最佳實踐:7 個很好的示例和模板

已發表: 2021-12-24

讓我給你看一張你可能熟悉的圖片:

看到“什麼是新的”部分?

這些可能是最常見的發行說明,即使是兒童也知道存在並從中獲取產品更新信息。

但是您是否知道,您如何設計和編寫這些發行說明會對人們如何看待您的產品產生重大影響?

我自己並不知道。

好吧,謝天謝地,我不是產品設計師。

但我確實知道一兩件事關於為什麼發布說明格式很重要以及如何編寫 fitire 發布說明。

因此,事不宜遲,讓我們深入研究一下:

軟件發行說明——為什麼它們是必要的?

發行說明非常重要,因為它們是客戶查找有關產品更新信息的具體位置。 儘管如此,如果您希望您的客戶真正閱讀發行說明,他們必須吸引眼球。

軟件發行說明 meme

如果您的所有客戶都不是客戶成功經理的好朋友,或者他們沒有和客戶經理一起去同一個賓果遊戲俱樂部,他們可能不知道您的產品更新了哪些內容或您的產品將發生什麼變化。即將發布的版本。

我不知道有多少人將未來的發行說明視為優先事項。 但是讓我告訴你,我將向你展示一些真正關心文本結構和設計的公司。 這些人正在引領互聯網。

他們讓您的用戶設定期望。

它充當自上一版本以來發生的變化、當前版本中的最新內容以及未來版本中將出現的內容的知識庫。

人們想知道是否已處理崩潰或已處理錯誤修復。

我聽到您說“是的,沒有人閱讀產品發布說明”,您是對的。 但這並不是因為它們不重要,而是因為它們寫得很糟糕。

當我收到來自 ClickUp 的“ClikcUpdates”電子郵件時,我個人感到非常興奮。

PS:在我澄清兩個更重要的事情之後,我將在下面給出更多示例:

誰應該準備發布說明?

發行說明是協作努力的結果。

營銷和支持可以創建它們之前,他們可能需要交接或更新的演示。

為確保按時編寫,產品經理可能需要支持或營銷團隊的推動。

技術作家產品、開發或測試團隊的任何其他成員都可以創建產品發布說明。 協作方法經常被用作產品發布過程的一部分。

發布說明中包含的內容

發行說明中包含的內容

讓我們列出一個好的發行說明模板的所有必要元素:

  1. 顯然,一個標題。
    不過,這不僅是一個無聊的舊標題。 非常歡迎您在標題中變得更有趣和更有創意。 不要只寫“App Update Notes – Version 2.14”或“Performance Improvements”,而是嘗試“In memory of our old version...”(只是一個想法)
  2. 快速概覽新功能。
    發生了什麼變化? 只有錯誤修復,還是您完全改變了功能? 相信我,人們會搜索這類信息並且他們會關心。
  3. 已解決問題的陳述。
    陳述以前關於函數的問題以及你是如何解決它的——也就是設定期望。 但不要忘記確保人們從一個人的角度閱讀,而不是機器人腳本。
  4. 影響和必要的行動。
    以前的版本有些不同,但是現在可能對 Reclaim Policy 或 Security Policy 進行了更改,人們可能需要確認一些配置。 讓用戶或客戶知道要採取的所有必要步驟。

發行說明分發 - 5 種方法

是的,應用內通知確實很重要。 是的,人們確實會打開發布電子郵件,只要他們參與其中。 是的,社交媒體是發布此類公告的有效場所。

就是這樣:

1- 電子郵件分發

發行說明可以通過電子郵件地址或一組地址發送給用戶。 我沒有什麼可以添加到這個標題的。 但我可以給你看一個很好的例子:

發行說明 ClickUp 的電子郵件分發

2- 社交媒體和社區分發

您還可以在 Twitter、Facebook、Google+ 和 LinkedIn 上發布發布說明。 社交媒體帖子可讓您接觸更多人。 這也是向非用戶宣傳您的發行說明的好方法。

發行說明的社交媒體和社區分發

3- 分發為網站內容

您的公司網站可能包含指向您的發行說明的鏈接。 或者,您可能想要創建一個關於您的版本的博客條目,並包含一個返回到您的版本說明的鏈接。

作為發行說明的網站內容分發

4- 應用內分發

當用戶打開應用程序時會出現一條通知。

如果您僅通過電子郵件發送發行說明,則在您的所有客戶再次打開他們的應用程序之前,它不會到達您的所有客戶。

應用內通知可讓您將消息傳遞給每個打開應用程序的新客戶。

發行說明的應用內分發

5- 應用商店公告

最後,最常見的源軟件發布,應用商店公告,如 Google Play 或 App Store。 如果您不記得開頭的相關示例,可以在此處找到它們。

6 個用作模板的軟件發行說明示例

所以現在是展示我迄今為止所談論的一切的時候了。 以下是 6 個最佳功能更新公告示例,包括電子郵件、應用內、社交媒體和所有其他示例。

1-點擊更新

ClickUpdates 是 ClickUp 功能更新的名稱。 對我來說,即使是名字也足夠有趣,可以打開網站並開始閱讀其中的內容。 看起來不像博客?

然後是設計。 這種設計有很多好的方面:

  • 它色彩斑斕
  • 雖色彩斑斕,卻有不少留白
  • 字體是可讀的
  • 文字大小引起了人們的注意
  • 他們有他們的作家名單。 我們知道這是人類。
ClickUp 發行說明示例

這種設計的唯一缺點是更新沒有標題。 不經常關注他們的人可能很難找到他們需要的東西。 但是發行說明的內部更好:

ClickUp 發行說明示例

2- Slack 發行說明

我個人並不經常閱讀發行說明,但當我需要了解某個產品的某些信息時,我會開始尋找。

Slack 從來沒有讓我失望過讓我找到我需要的東西。

這主要是因為分類系統和文本的清晰度恰到好處。

您甚至可以搜索特定的軟件版本。

Slack 覺得沒有必要詳細說明錯誤是什麼以及如何解決這些錯誤,因此避免使用複雜的詞語,並設法使註釋簡短有趣。

Slack 發行說明示例

此外,Slack 都有自己的內容,您可以在應用程序中找到新內容。

3- 為您打造的對講機

這個設計打動了我的心。

如果有什麼“適合我的”,我會接受的,拜託。

就像對講機的發行說明一樣。

即使留白空間不足,我也可以清楚地挑選出未來的版本和我正在尋找的功能。

頂部的設計、分類選項、它們縮短文本覆蓋空間的方式……都在重點。

他們也沒有忘記包含必要配置文件的相關鏈接。

對講機發行說明示例

對講機的頁面還有另外兩點讓它脫穎而出:

使用標籤將相關信息保存在一起

他們在底部進行了一些滿意度調查,讓客戶對功能進行評分。

4-不飛濺

Unsplash 是一個協作攝影網站,無需每週更新其服務。

因此,他們只是在博客上發布文章,以告知普通讀者有關新版本的信息。

由於他們不定期發布回收策略或安全策略更新,因此他們的方法可能是最適合他們的方法。

這是他們精心設計的一篇博客文章的樣子:

Unsplash 發行說明示例

5- 麵條

從下面的圖片中,我知道你可能會想“這到底是一個很好的例子嗎?”

但是,如果您仔細觀察,您會發現將產品的每個版本可視化的圖表是一個了不起的想法。

我真的希望他們能在他們的頁面上投入更多的精力。 它確實有可能變得比 ClickUp 的軟件發布頁面更好。

Moodle 發行說明示例

在此過程中,讓我們討論一下為什麼這個頁面不能成為我的最愛:

字體太小無法閱讀

有很多技術術語

顏色一點都不吸引人

6-微軟

這主要是由於微軟的設計和政策,但看看這個白而漂亮的頁面。

我真的覺得有必要強調頁面上空白數量的重要性。 是的,對於軟件發布頁面也是如此。

但真正引起我注意的是那張小紙條。

它簡要討論了客戶應該對新版本的期望,或者更具體地說,他們應該何時期望。

Microsoft 發行說明示例

此外,雖然它不是最全面的並且沒有搜索按鈕,但微軟設法提供了某種分類,以便更容易找到您需要的內容。  

結論

編寫和設計發行說明是那些看似不必要但實際上具有巨大影響的事情之一。

此外,準備它們可能感覺像是一種負擔,它們實際上非常簡單。

我希望我可以幫助您更好地了解創建軟件版本的最佳實踐以及如何發布它們。

經常問的問題


發行說明模板必須包含的 5 個要點是什麼?

首先,你應該有一種簡單易懂的語言。 其次,發行說明應該簡短。 第三,它們應該按邏輯分組,而不是隨機分組。 此外,應包括相關鏈接。 最後,人們應該能夠從發行說明中讀出貴公司的語氣。


好的發行說明是什麼樣的?

一個好的發行說明有一個粗體的標題,它不僅說“第 10 次更新”,一個聽起來很像人類的簡單但解釋性的正文,以及對必要確認的簡單描述。


如何在 Jira 中創建發行說明?

在 Jira 中創建發行說明版本並不是一個艱難的過程,儘管它包含一些細節。 在這裡,您可以了解如何在 Jira 中製作最佳發行說明。

{“@context”:”https://schema.org”,”@type”:”FAQPage”,”mainEntity”:[{“@type”:”Question”,”name”:”什麼是 5 大發行說明模板中必須包含哪些要點?”,”acceptedAnswer”:{“@type”:”Answer”,”text”:” 首先,您應該有一種易於理解的簡單語言。 其次,發行說明應該簡短。 第三,它們應該按邏輯分組,而不是隨機分組。 此外,應包括相關鏈接。 最後,人們應該能夠從發行說明中讀出貴公司的語氣。”}},{“@type”:”Question”,”name”:“好的發行說明是什麼樣的?”,”acceptedAnswer ”:{“@type”:”Answer”,”text”:” 一個好的發行說明有一個粗體的標題,不僅是“update no 10”,一個簡單但解釋性聽起來像人的正文,以及一個簡單的描述必要的確認。”}},{“@type”:”Question”,”name”:”如何在 Jira 中創建發行說明?”,”acceptedAnswer”:{“@type”:”Answer”, ”text”:”在 Jira 中創建發布說明版本並不是一個艱難的過程,儘管它包含了一些細節。 在這裡,您可以了解如何在 Jira 中製作最佳發行說明。”}}]}