Salesforce模块之写作风格

Salesforce trail head竟然有一个模块是关于写作风格。其实它是针对我们如何撰写文档、release note、回复关于技术问题的email等。让我们一看究竟。

 

原文连接

https://trailhead.salesforce.com/content/learn/modules/writing_style

 

一，voice and tone

voice是指持续性的写作风格. 比如诚实、清晰、风趣、鼓舞等。

tone是指某段语言的情绪感觉。它和对方是谁，当下环境都有关。比如和亲朋好友的tone，与一个陌生人的tone感觉就完全不一样。

 

自我检查：

是否清晰、重点明确、态度积极？

一个外行人能否看懂？

自己读一读，是否觉得有趣？

自己读后是否有想读下一篇的感觉？

 

用对话的语气而不是指令语气。

CTA：call to action 用动词作为headline来强调你能做什么

还可以用图表等方式辅助

站在读者角度去考虑他的状况、背景知识等等，来决定写什么和怎么写

 

要简洁

要直接。用日常化语言，避免晦涩词，用简单的句式。

避免无关的名词解释。

 

适合扫读

用户常常扫读，所以把重点列在前面。

把结果写在前面，解释列在后面。

要假设用户会在读到一半情况下停下来着手去做 （所以后半段信息可能被忽略）

 

具体

不要委婉模糊，而要指定具体名字。

写明具体要做什么

 

加点佐料

使用放松对话般的风格

避免技术化语言，除非对方懂

 

积极的语言

例子：你做...然后会看到....

反例：你不会看到...如果你不...

在描述功能改进时，强调用户的benefits而不是他们抱怨的设计问题

例子：我们做了极好的...改进，能帮用户提高效率

 

慎用感叹句

因为我们平时说话不会一直用感叹句，否则看起来很不正常。

仅在鼓舞或表达兴奋时使用，才使得感叹句起到触动人的效果

在error message / confirmation / instruction 里慎用感叹句

 

慎用Please

仅仅在给用户带来不便或者系统出问题的时候使用please。

如果是用户应该做某事时，不应该用please

 

慎用Sorry

仅仅在确实给用户带来严重问题时说sorry.

如果是小问题，不应该说sorry

 

在说sorry之前，考虑是否可改进design避免

 

以下场景用正式语气比较合适

1.坏消息比如数据丢失

2.读者正处于困境

3.内容非常技术化

 

用讲故事的方式抓住读者

我们的大脑对故事有特别的反应。故事比单纯的事实/数据更能抓住读者。

故事让我们更融入情景

故事更容易说服读者

 

很难用完整/完美的故事讲解整个文档，但是一些局部可以使用下列技巧

使用类比

使用能引起共鸣的事例

用“你”“我”

讲一个自己的故事

 

用图/动态图来讲解

 

joke的注意事项

有辅导作用

不要讽刺特定人群

有同理心

不滥用