前言
目前我们 Lab的文章主要投放在公众号上,目标用户是一些框架用户,其他公司的技术 leader,和一些入门用户
对于技术 leader,大多关心技术方案,因此我们要有总体的方案和设计概要
对于框架用户,这些用户多半会去 debug代码,所以不需要贴代码,更注重细节
对于入门用户,基础部分照顾一下,其他部分不宜太浅显。
一些本文的分享范围仅限公众号技术文章,其他的虽然也大多适用,但是需要大家自行斟酌。
写作方式
我从以下几个方面来说明,以下都是为了提供文章的结构合理性和可读性。
结构清晰
结构清晰,才能让读者明白,你在讲什么。很多文章,内容很多,但是结构逻辑混乱,看了一大段,也不知道在说什么。所以,建议在写作之前,写一个大纲,或者就是讲大小标题写出来,自己再看下,过渡流畅不流畅,比如,你先介绍 SOFARPC,又转回去介绍 RPC的原理,这样就很奇怪,应该循序渐进。按照清晰的结构写作。
这里我建议,文章中的标题,大多数情况下,不使用数字序列作为文章每个章节,大多数情况下,如果你要使用数字序列化作为章节,说明文章结构不够清晰。只能靠数字来梳理。建议做下检查。
通俗易懂
公众号文章,一定要通俗易懂,切记出现大量的本公司,或者本人经验的词汇,比如大量出现一些内部使用的短语,比如,假设介绍 Mosn,那么不能上来就说 Mosn怎么怎么,要说明白,这个词来自哪里,怎么来的,更不能直接开始,假设读者理解了 Pilot,envoy,这些东西。一定要站在读者的角度上,写出通俗易懂的文章。
需要将复杂概念介绍的通俗易懂的时候,应该使用类比,比如介绍 mesh的作用,官方最好的一个类比,就是 Mesh就是微服务之间的 TCP。
遣词造句
遣词造句,这个直接写出来遣词造句很好的文章,比较困难,只能通过不断地改,自己写完之后,多读几遍,是否存在一些非常口语化的用词,或者一些大量的重复语句,这种读起来非常疲劳。
在写的过程中,应该抱着你在跟读者交流的想法在写,可以适当出现疑问,反问等语句。不能大段大段的陈述。这样的文章,读起来也比较累。
图文并茂
公众号文章,由于大部分都是在手机上阅读,大段的文字即使再清晰,也很容易疲劳,不利于阅读和理解。因此,在一些关键的地方,需要有清晰的图解。图解不建议配色太过鲜艳。颜色不多于3种。这样,可以让文章读起来,有一定的暂停。呼吸感很重要。
写作内容
写作内容上,主要还是看积累和调研的结果。
内容准确
这个不用多说,一定要保证文章的准确性,如果不能确定,可以找其他的同学帮忙 review,如果还是不能确保,可以在文中特别指出,和读者进行交流。
来源可信
文中如果有必要采用开源的结论,或者经典的图解,一定要保证来源自最初的作者,不允许直接网上搜一下,随便找了一篇文章,就作为了来源参考文章。并且参考的文章,也要注意正确性,有些作者的文章,本身就是不正确的,如果还作为我们的来源参考,显然是不合适的。
写作规范
文章规范
中英文之间,要有空格。
全文使用中文逗号和句号。
专有名词,该大写大写,该小写小写。
图中文字20号字体起,否则手机上看不清楚。
注意事项
不允许直接采用其他文章中的图,版权问题
不允许直接拷贝其他文章中的文字,版权问题
