《技术写作指南》张鑫旭

然而,想要自知并非易事,人类在认知自己时总会高估自己,认为众人皆醉我独醒,实则恰恰相反,最看不清的就是自己,这在心理学上称之为“虚假独特性效应”。

我大学四年基本上就没学到什么东西,唯一有用的,影响终身的,就是一本名叫《人格心理学》的书,这是我第一次通过一些专业的理论知识来剖析自己的行为。

例如我为何坚持走技术路线,因为我的特质决定了我走这个路线的高度更高;为何我专注于前端领域偏用户体验的方向,因为我的性格特质更适合走这个方向;以及为何我写的技术文章更加通俗易懂,也是因为我那细腻的情感特质。

优质的文章往往都不是访问量很高的文章,稀缺的内容反而是低访问量的,而排在前面的那些文章,无非这三种:一是面试心得(短期收益明显)、二是资源合集(收藏过等于学过)、三是个人经历(八卦是人的天性),这些东西对技术提高就好比给了唐僧一把梳子,你还不能说毫无用处,毕竟还可以梳眉毛,眉毛也是“毫”。

经常面对一个议题或者一个问题都是大脑一片空白,比方说掘金的编辑大大和我商议写个关于技术写作的小册,那一瞬间,思维肯定是一片混沌的。 此时空想无益,应该脚踏实地,收集碎片信息,取笔落纸,然后归纳、梳理与汇总,这样,整个线条会越来越清晰。

先动起来,慢慢自然会知道怎么写

写作的内容

如果你只是一个人,而不是一个团队,如果什么方向的技术都写,注定是死路一条,因为个体的精力和学识都是有限的,而竞争者众多,你要想脱颖而出,只能找准一个方向,不断强化,才有可能。

一个正常的人类是不可能这些方向都面面俱到的,所以,如果你每个技术方向都插上一脚,写上一篇,那必然是泛泛而谈的一篇文章,请问,这样的文章除了锻炼了自己的打字速度,还有什么其他作用吗? 中国的互联网发展到现在已经二十多年了,行业发展日趋成熟,职业分工愈发细化,从业人员众多,根本就不缺那种入门的学习资料。

记住,我们的写作目的要么为了个人成长,要么为了脱颖而出,精力有限,时间有限,所有一定要专注在某个垂直领域,让自己的付出价值最大化。

就拿我自己来说,我写了七八百篇原创技术文章,几乎全部都围绕前端用户体验领域展开,什么人工智能、Node.js、微服务、Serverless 这些流行过的东西我就不会写,除非这些东西可以解决用户体验问题,这是一种为了长远利益的克制,这种克制让我的精力更专注,最终,不仅让自己成为用户体验方面的专家,同时强化了自己在这个方向上的标签,反过来让我在职场中更容易突破那层看不见的技术路线天花板。

选题

技术写作的选题分成了下面八类:

  1. 新方法、新特性、新技术;
  2. 日常工作中的小技巧,小创新;
  3. 深入理解 XXX,XXX 原理剖析;
  4. 技术实现方案综述、技术选型对比;
  5. 体现技术深度的棘手问题解决;
  6. 框架、工具、会议体验指南不指北;
  7. 外文翻译;
  8. 技术资讯与技术人文。

选题 2、3、5 则特别适合对技术有追求的同学,且一定要多写,收益斐然!

记住,工作实践的写作输出,最容易获得收益的地方是公司内部,毕竟关系到你在公司内部的影响力,也就直接关系到你的升职加薪,所以,对内输出一定是重点,对外输出是副产物,切不可弄错了主次。

可以想一个固定且好记的措辞,然后想办法在每篇文章中呈现。

比方说灰太狼的“我一定会回来的”,又比方说我文章中的每个演示页面地址前面都会有这么一句话——“您可以狠狠地点击这里”,这就是一种不断强化的措辞。以至于在盗版网站,别人一读到这句话,就知道是我写的。

当账号没有多少受众的时候,我们的分享是随意的,没有任何压力的,但是一旦受众多,那么大多数受众的品味喜好,观点认知就会反过来影响账号的内容。

技术的成长一定会转变成金钱收益,因为技术比人情更可靠,你所学习的技术知识,积累的那些细节和经验,百分之一百日后可以给你带来令你欣喜的价值,而且这个价值连绵不绝,持续不断,越筑越高。因为技术不像人,技术不会欺骗你,而且越基础的技术越忠诚。

时间是没有心理账户的,年轻时候的时间和年长时候的时间是等同的,年轻时候你 1000 块钱买 30 个小时觉得贵,等你中年时候再看就不贵了,等你年老濒死时想要再花 1000 块钱买 30 个小时,抱歉,虽然你觉得比白菜还便宜,但是已经买不到了。

努力与解决时间

不玩游戏不看连续剧; 不社交; 不线下购物。购物不聊天不砍价直接买,买到不合适从不退货,将就或再买一个; 不打扮; 住公司附近; 不自己做饭做菜,外面吃; 不自己洗衣服,洗衣店; 大小号使用离门最近的坑位; 上大号必带笔看书; 大瓶装水,可以减少去饮水机次数; 决不排队买东西; 甚至老婆都是从对面屋子找的。

对比我购物,东比西比,就怕自己买的贵了。犹豫不决,但是最后还是会买。最终反而是浪费了时间。 人生如此宝贵,不要在无意义的事情上浪费。

这本掘金小册大部分的内容其实都是在鼓励进行写作以及对与平台与写作内容进行分析。内容其实并不干,很容易阅读。对于风格指南之类的还需要自己去寻找另外的文档查阅。 于 2024-01-18 13:04 购买该小册,2024-01-18 22:59:35 读完。

《技术写作手册》 - 洞见

2024-01-19

那么什么样的事情是我们心甘情愿想去做的呢?为什么 我们喜欢玩游戏而不喜欢写作业?那些我们根本不需要 “坚持”就能一直做下来的事情都有什么样的特点呢? 想来想去,我认为一般要符合两个条件:快速的正向反馈、相对容易。

我就曾经疑惑过学习与玩的区别到底在哪?玩游戏可以 让我们相对容易能短时间内满足生理或是心理上的需 求。但是学习首先不容易,有好处但反馈周期都相对较 长,我们很难获得比较快的正向反馈。可是有些好学生 就非常喜欢学习不是么?因为他们可以从每次考试,每 次回答问题,从老师家长赞赏的同学羡慕的眼光中得到 很多正向反馈,而更重要的是这种反馈足够快,所带来 的收益已经抵消甚至大过了在学习上投入的成本,这就 是为什么好学生会越来越喜欢学习的原因。

我们常说要培养孩子的兴趣,这样他就能在某一方面作 出成就。我认为这个逻辑反了,应该是先促使或是找到或是暗示孩子在某方面的成就,让他觉得自己在这方面 比别的小朋友强,他就能在这件事情上持续获得更多的 正向反馈(例如夸奖,奖励,其他小朋友的羡慕),就 会越来越喜欢做这件事情,兴趣自然而然的就形成了。

  • 快速的正向反馈

姜文在一次谈话节目中也被主持人问及了相似的问题, 主持人抛出了两个观点,一是电影只不过是用来满足人 的低俗需求,二是电影中的考究对观众来说真的有所谓吗。

姜文的回答是:“俗人是要往高处走的……给人点好东 西吃,他会记着你原来对人的尊重来着……我是一个非 常正能量,一个乐观的人,我觉得他今天不懂,他有一 天会懂的。等他懂的那一天回来想,老姜真对得起我…… 给人点好东西吃,他会记得你原来对人的尊重来着。您 天天想着接地气,掏人兜里的钱,人家也进步着,回头 一看,孙子,你当时给我拍什么烂电影看”