作为设计师,我想要更好的版本说明

原文标题:As a Designer I want better Release Notes ——Simple visual design, applied to plain text release notes
作者:Rob Gill,UX Manager @PerformGroup.
翻译:王很远
原文地址

写版本更新说明是个有争议的话题。有些公司选择简单处理(通常有一个「好」理由[1] ),有些公司则煞费苦心[2]

通过应用简单的文本结构和基本版式,在只使用纯文本的前提下,也可以大大提升你的版本说明的视觉效果和阅读体验。本文涵盖几个关键领域,最后提供「完美的版本说明模版」。

最佳实践

1.先总结再详述

大家都很忙的,先从总结开始,再说明更新细节。

TL;DR.(太长不看)——1Password 和 Medium 都使用过这种先总结再说明细节的方法

2.重新提醒重大更新

如果在发布一个大版本之后紧急修复了重大 Bug ,确保在新版本的说明中再次提醒上个版本的重大更新。有助于未及时更新的用户了解你更新的新功能。

在大版本后修复 Bug?别忘了你那些幸苦的工作

3.让用户轻松联系到你

一个统一的外部反馈渠道可以有效避免负面评价。确保这里的文案简洁到位。「我们很重视您的反馈意见,您可以通过这些渠道联系我们:Email、QQ 群、微信 etc.」如何让用户的反馈渠道更简单方便,是专业用户体验设计的关键。

The Guardian & Onefootball

基本版式

1.项目符号

  • 拆分说明,不要使用大段文本,请精炼总结
  • 每个功能点单独占一行,行首建议使用圆点「•」
  • 可以使你的项目符号富有创造性以获取额外效果。例如 ESPN 使用「+」
  • 甚至可以在一个项目下使用子项目
  • 保持创造性是很有意思的事,但是别哗众取宠。一旦你确立了一种写作风格,一定要自始而终保持统一。ESPN 一直都保持他们独特的风格符号
使用项目符号分割能使一坨文本快速提升可读性--IMDB & ESPN

2.小标题

你可能还需要使用小标题来区分更新的功能点。考虑使用一些符号譬如「-、#、+、*」来表示小标题。不管如何你还是要确保写作风格保持统一。

标题 —— Two Dots &Trello

3.区分内容

新特性 vs 改善 vs BUG FIXES

使你的标题更简洁精炼。把你的版本更新说明分解为你需要用户知道的新特性,还有已修复的问题。新特性/功能应该写在前面。

Mindnode & 1Password

4.空间

你的段落应该留有呼吸空间。使你的用户更容易阅读每个更新点而不是丢给用户一大坨文本。

没有对比就没有伤害 ——Outlook & Slack

写作风格和内容观点

1.不要担心把 Bug 说出来

修复了一个影响大量用户的 Bug?快告诉他们吧!这对他们来说是一个很好的改进。小修小补则可略过。

Clear Score 宣布解决了一个大问题

2.把你的 Bug Fixes 提升到另一个高度

(我不知道这样做有没有卵用,尤其是对外部人员来说。但是谁知道呢……[3]
考虑把错误代码写进你的版本说明。我想说的是,这一步做不做都关系不大。但是别忘记,写作风格统一是关键。

1Passeword 丧心病狂地把错误编号也写上

3.即将更新

有些功能研发过程很曲直,但是你知道这些大招就要完成研发。快告诉用户一切都在计划之中,新功能就要憋出来啦!

就快憋出来了,再等等…… —— IFTTT

4.个性化

热情地和你的受众人群打招呼别害羞。

Onefootball & Photobox 使用了讨巧的写作风格

如何克服挑战

在一个多语言的大公司工作,对于版本说明我们面临许多挑战。以下是我们解决常见问题的一些方法。

1.许多细微的更新,比如底层和小像素调整:

不要独立写版本说明。如果你付出了努力,你的团队肯定有话要说,无论用户认为改动多么小。每个人都为这个版本付出了努力,使用协作文档让每个人都参与进来,最后总结输出。

2.有些时候,我们需要快速发布版本以修复 Bugs:

超级小或者无聊的 Bugs Fixed 可以成为写成「Bugs fixes(修复小错误)」。但是准备一段贴心的反馈路径或个性化应用说明可以避免这种重复。

3.没人阅读应用商店的更新说明怎么办

随着 iOS 和 Android 推出自动更新功能以来,毫无疑问在应用商店阅读更新说明的人越来越少。
如果你采取了以上的建议,你肯定会认真对待你的版本说明。如果你想要与用户产生互动,千万不要等着用户去应用商店阅读你的版本说明。
在告诉用户新特性(功能)的引导上,SofaScores 做了很好的示范。通过醒目的小红点,引导用户去到有详细说明更新内容的「What's New」页面。

SofaScores 在应用内完成引导

另外,你用心排版编写版本说明不应该浪费。相同的文案和版式可以在宣发邮件或 App 内部的 What's New 页面重复使用。不管在 App 内部或 App Store Withings 的文案都保持一致。

Withings 内部和 App Store 上的文案一致

理想的版本说明

以下是一份理想版本说明模板

开头写一段简短的个性化介绍。比如说「Hi,老铁!春天到了,这个版本>我们也更新了许多生气勃勃的功能和提升了整体性能哦!」

TL;DR(Too long;Didn't read 的简写:太长不看)

  • 这里写上这个版本说明的总结

~ 新功能 ~

  • 这里写上新功能是什么
  • 解释这些功能在你 App 中的位置
  • 用户如何找到这些新功能- 哪些用户会受益,或者这对他们有什么好处
  • 举个栗子:(谁会受益?)Apple Watch 用户会对最新版本特别满意。(为什么?)我们现在支持与您的 Mac 自动切换。(在哪里/如何?)不要忘记打开你的蓝牙,你是最棒的!

~ 改进~

  • 如果改进现有功能(而不是全新功能),请使用「改进」标题而不是「新功能」
  • 如果你根据用户的反馈改进了某些内容,试着使用这样的句子,例如「你说,我们听」。让用户感受到他们是受重视的。

~ 修复 ~

  • 列出影响大量用户的 Bugs- 如果只是修复了小问题,请使用这样的句式「修复了一些小错误」
  • 如果你使用了分标题编写说明的话,请保留「修复」这个小标题

这里是底部签名。类似于介绍,尽可能个性化一点。你要知道,有这样一个介绍段落也是极好的。

最后是反馈渠道,可以是 Email 地址、QQ 群号、微信号等。确保用户可以方便的联系到你。例如:
您可以通过以下方法联系我们,告诉我们您的宝贵意见:
QQ 群:XXXXXX
Email 地址
微信号

从「好」到「优秀」

我前老板的一段话影响了我很长一段时间。

从「平庸」到「好」的差距很大,人们需要努力工作才能达到「好」。但是,从「好」到「优秀」只有极短的 2 毫米的距离,他们从来不知道他们离实现「优秀」是多么接近。
——Danyl Bosomworth(基于 Tony Robbins 的 2 mm 规则)

编写优雅的版本说明,是 2 毫米差异一个很好的例子。一个小区别,对于推动你的 App 从「好」到「优秀」有着极大的帮助。
如果你是设计师,找到你的发布经理或项目经理。用你的专业知识,帮助他们达成这额外的 2 毫米。


  1. Facebook 员工解释 Facebook Release Note 简单的原因
    https://www.reddit.com/r/iphone/comments/2jcy4r/facebook_replies_to_outrage_over_lack_of_changelog/

  2. Slack 员工 Anna Pickard 对编写 Release Note 的建议
    https://slackhq.com/a-little-thing-about-release-notes-997d2e06842d

  3. 确实没什么卵用

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 196,165评论 5 462
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 82,503评论 2 373
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 143,295评论 0 325
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,589评论 1 267
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,439评论 5 358
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,342评论 1 273
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,749评论 3 387
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,397评论 0 255
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,700评论 1 295
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,740评论 2 313
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,523评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,364评论 3 314
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,755评论 3 300
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,024评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,297评论 1 251
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,721评论 2 342
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,918评论 2 336

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,140评论 25 707
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,517评论 18 139
  • 背景: 阅读新闻 12C CDB模式下RMAN备份与恢复 [日期:2016-11-29] 来源:Linux社区 作...
    阳屯okyepd阅读 3,316评论 0 7
  • 小小孃没比我大几岁,她是父亲最小的妹妹。妈嫁到奶奶家时,小小孃还是一个需要被照顾的小小孩。 我读小学的时候,小小孃...
    我是木土土阅读 562评论 1 11
  • README.md 前言 项目介绍 项目演示 GitHub 地址在线演示 功能介绍 1. 首页开发GitHub 地...
    Magiccwl阅读 1,311评论 0 4