V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
爱意满满的作品展示区。
samray
V2EX  ›  分享创造

写了一篇《简明写作指南》, 分享给大家

  •  6
     
  •   samray ·
    ramsayleung · 2024-03-23 00:52:17 +08:00 · 4477 次点击
    这是一个创建于 374 天前的主题,其中的信息可能已经有所发展或是发生改变。

    不久前看完了美国证券委员会的 A Plain English Handbook(简明英语写作指南), 写了篇感想《简明写作指南》

    原文在我的博客公众号上.


    1 前言

    最近在阅读李笑来的《人人都能用英语》[^1],想要继续提升自己的英语能力。
    李笑来是新东方出来的英语教学名师,此书由浅入深来介绍如何「用」好英语,而不是像在学校那样「学」好英语。

    在《口语篇》中,李笑来提到,比口语更重要的是思考能力,英文说不出口的原因,可能是脑子里面没有什么思考沉淀的东西可以说的,并藉此推荐了三本关于文风( Style )的必读书籍,其中一本就叫:A Plain English Handbook(简明英文写作指南)[^2]。

    这本书竟然是美国的证券交易委员会(Securities and Exchange Commission)1998 年编著的, 旨在指导投资机构和金融机构创建更清晰,更易理解的披露文件。

    可能是投资机构写的东西,普通投资者根本看不懂,逼得证券交易委员会都要下场指导投资机构写作了。

    这本小册子只有 83 页,内容却很详实,读完之后,觉得其中的许多技巧不只适用于英文写作,
    因此就结合读后感和个人心得,分享下简明写作的心得。

    2 为什么写作

    以我自己的工作为例,日常开发新项目,需要撰写文档来向同事和经理介绍项目背景,
    动机和具体的实现细节,以寻求支持并推动项目的进展;技术交流时,需要撰写文档分享你的成果和经验;在晋升时,需要撰写文档,给自己找数据点来说服经理,为什么要给我晋升。

    需要让别人「看见」我的时候,写文章就是一种非常好的手段,默默无闻的老黄牛,是很难被人看到的,酒香也怕巷子深。

    你可能会认为自己工作用不到文档,但是你总归是要向同事或者上司阐述自己的观点,
    无论是述职,晋升,演讲,甚至口头汇报,用文档作腹稿, 理清脉络,做到胸有成竹。

    关于写作的动机和好处,我之前写过一篇文章专门来聊:《闲聊写作的好处》,这里就不赘述了。

    3 如何写

    如果把文章比作一个人的话,那么文风就是人的血肉和皮囊,文章的结构就是人的骨架,只有当骨架先立了起来,才能在其上涂血肉,张皮囊。

    A Plain English Handbook 主要介绍的是改善文风的技巧,那么如何立起文章的骨架呢?我推荐的是黄金圈法则和金字塔原理。

    3.1 结构

    3.1.1 黄金圈法则

    所谓的黄金圈法则,概括来说,就是思考问题的三个层面,分别是:

    • Why: 最内层, 为什么,做一件事的原因或者目的,也就是我们为什么做这样的事情,战略层面。
    • How: 中间层, 怎么做,我们如何实现我们想要做的事情, 战术层面的事
    • What: 最外层,事情的表象,我们具体做的每一件具体的事,执行层面的事


    比如我要推动一个新项目,需要写项目文档,或者口头向老板阐述项目,如果不用黄金圈法则,可能会是这样表述的:

    • What: 我要做一个 XX 的服务,会有哪些新功能
    • How: 我是通过什么业界领先的 XX 技术实现的,用到了什么组件.

    如果以黄金圈法则来重写项目文档,那么文章的结构应该是如何的:

    • Why: 我们为什么要做这个项目?这个项目能给我们带来什么好处,不做会有什么损失?
    • How: 大方向上应该怎么实施,大概会用到什么组件,架构如何?
    • What: 具体的底层实现是什么,每个组件是怎么实现的?

    大方向没有定好,再走下去也只是南辕北辙,于事无补。

    其实这篇文章也使用了黄金圈法则,开篇就介绍为什么要写作,后续再介绍如何写作。

    3.1.2 金字塔原理

    关于金字塔原理,我觉得冯唐的《老聃的金字塔原理》一文[^3]已经解释得非常清晰明了了:

    用一句话说,金字塔原则就是,任何事情都可以归纳出一个中心论点,而此中心论点可由三至七个论据支持,这些一级论据本身也可以是个论点,被二级的三至七个论据支持,如此延伸,状如金字塔。


    如果用金字塔原理来分析「为什么小王是个好对象」的论点,那么论据就可以拆分成:

    • 家境殷实
      • 年入百万
      • 有车有房无贷
      • 父母养老无忧
    • 前景光明
      • 名校毕业
      • 年纪轻轻身居中层
      • 领导赏识
    • 相处融洽
      • 提供情绪价值
      • 共同话题多
      • 情绪稳定
    • 颜值高
      • 皮肤白里透红
      • 五官端正
      • 身材修长
      • 穿衣显瘦,脱衣有肉
      • 基因好,后代获得先发优势

    写作时,每个一级论据就是一个大的篇章,每个二级论据就是篇章下的章节,三级论据就是章节里面的小节,
    依此类推,并给予最底层的论据适当的文字描述。
    如果还不够的话,还可以继续向下拆分论据。

    有了黄金圈法则和金字塔原理,就很容易把一篇文章的结构给搭起来。

    3.2 文风

    3.2.1 明确你的观众

    明确你的观众,是确保你写的文档能让人理解的最重要步骤。

    不同的读者,有不同的背景,对你要传递的信息是有不同的理解难度。

    以我自己为例,因为我在公众号写的文章大多都是与编程技术无关的,
    那么吸引到的读者自然也不会是编程从业者,所以我在公众号里面写技术文章,基本不会有什么读者阅读。

    兼之微信这个阅读平台本身的局限,大多数情况下只能是在手机上阅读,
    读者无法投入大量时间「沉浸式」地主动阅读,可能是快速下拉翻页读完了。
    而图表和代码在手机屏幕上展示效果不佳,就进一步影响阅读体验了。

    如果我把写满技术名词和代码的文档给一个完全没有技术背景的读者来阅读,
    即使我的文档写得妙笔生花,对他也没有任何信息可言。

    因此我基本不会在公众号写技术文章,技术文章都放在更适合在电脑阅读的博客上。

    这里还有个小技巧,就是在明确你的观众的时候,可以设定到一个具体的人,
    例如是你的女友/男友,你的同事,或者是你的经理。

    具体的人比抽象的概念更深入人心。

    3.2.2 言简意赅

    能用简洁明了的段落表达全的信息,就不要长篇大论。

    读者是有心智负担的,文章的内容越长,读者的负担越重,就越有可能在还没读完的情况下将文章关闭。
    另外一方面,如果要传递的信息量是固定的,你的文章内容越长,你文章的信息密度越低,通俗点来说,就是干货越少。

    所以我对「万字长文,讲透 xxx 」,「爆肝 x 天,四万字长文带你解读 xxx 」之类的文章不感冒,
    文字多也不能说明干货多,爆不爆肝和干货含量也没有逻辑关联。

    现在写作不按字数算稿酬,不需要搞「文字灌水」。

    《唐宋八家丛话》中有一说:

    欧阳修在翰林院时,常常与同院他人出游。

    一次,见有匹飞驰的马踩死了一只狗。

    欧阳修说:“请你们尝试描述一下这事。”

    一人说:“有犬卧于通衢,逸马蹄而杀之。”

    另一人说:“有马逸于街衢,卧犬遭之而毙。”

    欧阳修笑说:“像你们这样修史,一万卷也写不完。”那二人说:“那你说呢?”

    欧阳修道:“逸马杀犬于道。”

    那二人相互笑了起来。

    3.2.3 少说黑话

    少说黑话和行话,例如「组合拳」,「赋能」,「抓手」之类的,字我都认识,合起来就不明白是什么意思。

    如果你明确了你的观众,你可能就会意识到你的观众大概率无法理解这些话语。

    多用具体的,意思明确的词,会更让读者更容易理解。能用简单的话解释清楚一个复杂的概念,就说明你对这个概念的认识越到位。

    黑话用多了,也是一种「文字腐败」。

    3.2.4 控制段落长度

    上文提到,读者是有心智负担,负担越大,他们就越有可能在阅读你文章时「半途而弃」。

    而一大片文字密密麻麻糊在一个段落,就会进一步加重他们的心智负担。

    我一般推荐 80 到 150 个字一个段落,这样看上去不至于太吓到读者。

    3.2.4.1 使用空行

    段落与段落之间,用 空行 分隔. 空行是个非常简单,但是却异常有效的技巧,既可以拆分段落,控制单个段落的长度,也可以表达不同段落逻辑上存在并列或者递进的关系,便于读者理解。

    同样的文字,使用空行分隔段落的前后对比如下:

    ![]( https://gitea.com/enriquejose/store/raw/branch/master/static/ox-hugo/控制段落长度 1.png)

    ![]( https://gitea.com/enriquejose/store/raw/branch/master/static/ox-hugo/控制段落长度 2.png)

    3.2.4.2 使用列表

    另外一个控制段落长度的有用技巧,是使用列表(bullet list),可以表达列表中的每个点都是并列关系。

    例如,分析跑步的好处:

    跑步不仅可以增强免疫系统,帮助抵御病毒和细菌,降低患病风险; 还有助于心肺功能,降低心脏病和中风的风险; 更可以减脂、增强肌肉,改善体形; 甚至促进肠道蠕动,有助于消化。

    如果换成列表,那么跑步的好处就是:

    • 提高免疫力:增强免疫系统,帮助抵御病毒和细菌,降低患病风险
    • 改善心血管健康:有助于心肺功能,降低心脏病和中风的风险
    • 塑造好身材:可以减脂、增强肌肉,改善体形
    • 促进消化:促进肠道蠕动,有助于消化

    如果还有优点补充,只需要继续增加列表就好了。

    3.2.5 一图/表胜千言

    人的大脑对图片远比文字和声音敏感。

    图片比文字来说,更容易被大脑接受,大脑储存图片信息也不需要进行过多的转译,而文字进入大脑之后,还需要用“想象力”处理成画面进行记忆,这也就是为什么带生活实例的文字会比概念化的文字更容易让人记住,因为前者更容易让你想象具体的画面。

    通俗地讲,就是一图胜千言。

    所以要减少读者的心智负担,那么就应该多使用图表,因为它能更直观地传递更多信息。

    以国家统计局发布的 2 月份居民消费价格分类同比涨跌幅为例,文字描述如下:

    其中,教育文化娱乐、其他用品及服务、衣着价格分别上涨 3.9%、3.0%和 1.6%,医疗保健、生活用品及服务、居住价格分别上涨 1.5%、0.5%和 0.2%;交通通信价格下降 0.4%。

    图表如下:

    ![]( https://gitea.com/enriquejose/store/raw/branch/master/static/ox-hugo/2 月份居民消费价格分类同比涨跌幅图.png)

    关于如何画图,我之前也写过一篇文章来分享心得:《我的画图流:画图工具与技巧分享

    或者换成表格:

    类别 涨跌幅
    教育文化娱乐 + 3.9%
    其他用品及服务 + 3.0%
    衣着 + 1.6%
    医疗保健 + 1.5%
    生活用品及服务 + 0.5%
    居住 + 0.2%
    食品烟酒 - 0.1%
    交通通信 - 0.4%

    4 如何写好

    4.1 多读多思

    杜甫说,读书破万卷,下笔如有神。诗圣的意思是如果你通读过万卷书,就好像 ChatGPT 一样,思如泉涌,下笔如有神

    陆游又说,纸上得来终觉浅,绝知此事要躬行。陆放翁的意思是,你在书上的读到的东西,也只是信息,如果没有实践过,终究不能成为技能的。

    总结两位老人家的话,也就是说,多读书是写好文章的必要条件,多读书不一定能写好文章,但是不多读书呢,就一定写不出好文章。

    毕竟写出来的东西,不会凭空而来,还是你脑子思考好的结果。

    4.2 多写多改

    与金庸并称香港四大才子的倪匡,一生写了 300 多部小说、400 多部电影剧本。

    他曾经自嘲没有谋生本能,所以看见人家写自己也写,自称是全世界写汉字最多和最快的人,自入文坛已写作三十年,
    一个星期写足七天,每天写数万字。他在创作最高峰曾同时写作十二本科幻小说。

    当被问及有何建议赠给写作的人,倪匡说只有一个「写」字,只有多写才能得到更多的灵感。


    苏轼的《东坡志林》写到,有人问欧阳修怎么写文章,他回答说:

    无他术,唯勤读书而多为之,自工。

    世人患作文字少,又懒读书,每一篇出,即求过人,如此少有至者。

    疵病不必待人指摘,多做自能见之。”

    世人文字写得少,又懒读书,写一篇文章就希望可以超越别人,像这样是难有写得好的人。

    书读多了,落笔为文,文章写多了,自然就写好了。

    写作的「捷径」就是老老实实多读书、多思考、勤写作。

    多练多写多修改。

    只有产量提上来了,工艺才会成熟,良品率才会提高。

    5 总结

    写作并非是雄关漫道,遥不可及。

    大家都写过作文,写作也只是一种交流方式,无非是把脑海中的想法以文字的形式付诸于纸上,比聊天更加正式而已。

    千里之行始于足下,万巻之文始于笔下,开始写就好了。


    [^1]: https://github.com/xiaolai/everyone-can-use-english/blob/main/book/README.md
    [^2]: https://www.sec.gov/pdf/handbook.pdf
    [^3]: https://zhuanlan.zhihu.com/p/196733201

    第 1 条附言  ·  2024-03-23 01:38:15 +08:00

    不知道为什么,原来的图无法正常展示, 只能在append 补充下了.

    3.2.4.1 使用空行

    段落与段落之间,用 空行 分隔. 空行是个非常简单,但是却异常有效的技巧,既可以拆分段落,控制单个段落的长度,也可以表达不同段落逻辑上存在并列或者递进的关系,便于读者理解。

    同样的文字,使用空行分隔段落的前后对比如下:


    3.2.5 一图/表胜千言

    通俗地讲,就是一图胜千言。

    所以要减少读者的心智负担,那么就应该多使用图表,因为它能更直观地传递更多信息。

    以国家统计局发布的 2 月份居民消费价格分类同比涨跌幅为例,文字描述如下:

    其中,教育文化娱乐、其他用品及服务、衣着价格分别上涨 3.9%、3.0%和 1.6%,医疗保健、生活用品及服务、居住价格分别上涨 1.5%、0.5%和 0.2%;交通通信价格下降 0.4%。
    

    图表如下:

    15 条回复    2024-03-24 11:11:09 +08:00
    youngxhui838
        1
    youngxhui838  
       2024-03-23 04:28:42 +08:00 via Android
    学习了,写的很好,感谢分享
    go233
        2
    go233  
       2024-03-23 08:01:51 +08:00 via Android
    学习了,感谢分享
    todayisgood
        3
    todayisgood  
       2024-03-23 08:16:38 +08:00
    好的
    ma836323493
        4
    ma836323493  
       2024-03-23 09:06:55 +08:00
    使用空行, 这个学到了
    tees
        5
    tees  
       2024-03-23 09:21:27 +08:00
    大佬,写的真的很棒
    RLinux
        6
    RLinux  
       2024-03-23 11:21:22 +08:00
    111
    ITHaoge
        7
    ITHaoge  
       2024-03-23 11:57:08 +08:00
    挺细致的,收藏学习了
    klo424
        8
    klo424  
       2024-03-23 13:19:12 +08:00
    学习了。
    ppen522
        9
    ppen522  
       2024-03-23 14:47:40 +08:00
    输出才是学习的本质。
    EngAPI
        10
    EngAPI  
       2024-03-23 16:36:11 +08:00
    很有启发,本学工,但非常想写。
    sx1051566182SUMM
        11
    sx1051566182SUMM  
       2024-03-23 19:34:28 +08:00
    谢谢大佬,收藏学习了!
    molezznet
        12
    molezznet  
       2024-03-23 23:49:32 +08:00
    正如李笑来说的,edge tts 是好东西
    R4rvZ6agNVWr56V0
        13
    R4rvZ6agNVWr56V0  
       2024-03-24 02:24:16 +08:00
    在补充一个技术协作方向的《文案风格指南》 https://open.leancloud.cn/copywriting-style-guide/
    wuzhi1234
        14
    wuzhi1234  
       2024-03-24 10:54:35 +08:00
    写得很好,受教了!
    hidie
        15
    hidie  
       2024-03-24 11:11:09 +08:00
    学习了
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   实用小工具   ·   1017 人在线   最高记录 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 56ms · UTC 19:10 · PVG 03:10 · LAX 12:10 · JFK 15:10
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.