惯性聚合 高效追踪和阅读你感兴趣的博客、新闻、科技资讯
阅读原文 在惯性聚合中打开

推荐订阅源

有赞技术团队
有赞技术团队
G
Google Developers Blog
T
Tailwind CSS Blog
让小产品的独立变现更简单 - ezindie.com
让小产品的独立变现更简单 - ezindie.com
人人都是产品经理
人人都是产品经理
J
Java Code Geeks
P
Proofpoint News Feed
V
Visual Studio Blog
爱范儿
爱范儿
The Cloudflare Blog
博客园 - 叶小钗
V
V2EX
freeCodeCamp Programming Tutorials: Python, JavaScript, Git & More
M
MIT News - Artificial intelligence
Microsoft Security Blog
Microsoft Security Blog
博客园 - 聂微东
H
Help Net Security
B
Blog
OSCHINA 社区最新新闻
OSCHINA 社区最新新闻
博客园 - 【当耐特】
量子位
宝玉的分享
宝玉的分享
WordPress大学
WordPress大学
钛媒体:引领未来商业与生活新知
钛媒体:引领未来商业与生活新知

少数派

派早报:Google 发布 Fitbit Air 等 - 少数派 「新人报到」確認需求,再開始 - 少数派 从 SOLO 独立开发者社区,我看到了越来越多开发者开始做自己的产品 - 少数派 我怎么管理那些"不常做,但总会忘"的生活事项 - 少数派 人形机器人量产元年,数据才是具身智能的“生死线” - 少数派 BuhoLaunchpad 高度还原 Mac 启动台:开发历程与思考 - 少数派 五年陪伴依然不舍,DIY 换壳后让罗技 MX Master 3 继续服役 - 少数派 新玩意 240|少数派的编辑们最近买了啥? - 少数派 一日一技|为什么你应该关闭 iOS 的键盘声音 - 少数派 我做了个插件和 Skills,一键提取任何网站的设计规范 Design.md - 少数派 住在三四线城市的你,该开始录播客了 - 少数派 甘南秘境,大白高国 - 少数派 AI的审美:谁让把我变成川内倫子 - 少数派 返工怎能不烦恼,打工人片单总有一部是你的「嘴替」 - 少数派 为了让「上厕所」更健康,我做了一个小工具 - 少数派 AI + Skill,能够让生成的文章去除 AI 味吗? - 少数派 新玩意|韶音OpenDots ONE 耳夹式耳机 - 少数派 《美满》| 在每一个春天的晚上相爱(362) - 少数派 新玩意|优篮子 PS01 MagSnap 磁吸支架 - 少数派 自我整合手记 | 我开始早睡了:用稳定规则,为自由托底 - 少数派 用龙虾(OpenClaw)两个多月,我最深的12个体会 - 少数派 听歌时间到,12 张你可能错过的 2025 华语乐坛好专辑 - 少数派 承诺能追吗 - 少数派 macOS 26启动台没了? 我做了个不一样的App启动器 - Keboard - 少数派 《四海为家的人》| INTJ对话INTJ(361) - 少数派 你发过的那些黑历史,是时候一次清干净了 - 少数派 新玩意:安安静静玩,越玩越专注:计客密码机 - 少数派 iPad 用户首次体验 Android 平板:vivo Pad6 Pro - 少数派 数据逻辑强 - 少数派 极北行+ | 一路向北,探访日本至北之地 | 001 - 少数派
程序员的写作课:一、关于技术写作的那些错误思想 - 少数派
2018-09-18 · via 少数派

破山中贼易,破心中贼难 —— 王阳明

在正式开始我们的课程内容之前,我们先来聊一聊技术写作过程中,你会遇到的那些错误的思想,让你对技术写作有所改观。

1. 我们搞技术的人写不来文章,那个是运营(文案)的活

写作是属于我们向世界表达看法的工具,它属于每一个人。你写一句话也是写作;你写一段话也是写作;当你开始写的时候,你就已经在写作了。

不要畏惧写作,写作是我们必备的技能,在职场中,我们经常要写周报、年报,在家里我们偶尔要给老婆写一下感言,这个东西我们必需,所以我们必练。

对写作重视起来,然后开始写吧!

2. 技术写作文笔不重要,干货才重要

不少程序员在写作时不甚用心,可以理解,毕竟大家工作那么忙,总是996,哪来的时间写作呢,但是,时间不足不意味着你就可以认为「内容重要,文笔不重要」

首先,文笔也是内容的一部分,当你说出内容重要文笔不重要时,你就将文笔与内容割裂开来,在一开始就出现了错误。

其次,对于文笔,我们的确不应该以专业作家的要求来要求普通的程序员,但是不意味着你可以完全不在意文笔,甚至以文笔好为耻,认为那不是一个正经的「程序员」。写作与每个人都有关,与职业无关,我们每个人的文笔不可能都做的非常好,但是,我们可以让自己的文笔在自己所能做到的极限中,达到最好

最后,文笔的好坏往往以修饰词出现的多少,语句之间的起承转合的流程与否来进行评判,这使得文章中出现了大量的与核心思想本身无关的内容,固然让文字显得「水」了一些,但是,却能让你的文章的可读性大大的提高,不再晦涩难懂。

所以,想要写好文章,首先,别拒绝文笔

3. 技术文章只要干货多,就是好文章

干货是我们经常评判一篇文章好坏的标尺,对于干货较多的文章,我们会点赞,对于干货较少的文章,我们就会唾弃。

但是,在写文章之前,你需要先考虑你的文章的受众,再进行干货的排布。

面向高级工程师和初级工程师的文章对于干货的需求必然是不同的,如果你错配了需求,干货再多,也会被读者吐槽。

一个比较典型的例子是,当你需要写给初学者看的时候,干货异常丰富的官方文档可能并不是一个好的选择,太多的干货带来的巨大信息量会让初学者在一开始整个信道就被占满,无法进行内容的学习,同时,还会在一开始给他巨大的学习压力。个人写的教程、视频教程则相反,抽离出最核心的内容,并对内容进行排布,让初学者可以很轻松的就进行内容的学习。

但是,我们在写文章时,不能为了更好的可读性就一味的降低干货的量,所以,面对初学者的文章时,你除了尽可能的简化你所能提供的信息,还需要平衡干货的量,这一部分,我通常是以参考链接延伸阅读的形式来完成的,帮助读者更好的去学习所学的内容。

4. 吸引眼球的标题不是好标题

标题只是一个工具,真正令人讨厌的不是标题,而是标题背后的那个人。

我们每个人都讨厌标题党,但是我们不应该讨厌一个好的标题。标题党的主要行为是「发帖的标题严重夸张,帖子内容通常与标题完全无关或联系不大」,让我们有较高的期待和随之而来的较大的失望。但是从功用的角度来说,他们的标题很好的完成了自己的工作,将人们吸引进来。

在信息充裕的时代,我们往往会通过信息流来选择自己想要看的内容,这个时候我们必然不能通过阅读每一篇文章来选择,那样就不是选择,而是遍历了。在这个时候,一个好的标题,能够帮助你更好的吸引读者进来看,让你的内容能够从众多的文章中脱颖而出。

我们应该合理的利用好标题吸引读者进入的功能,来为我们的文章选择更多可能的读者。

5. 写作只是写就可以了

写作不单纯是写,写只是写作中最后一个环节。

写作的完整流程应当是「输入」- 「处理」 - 「输出」,你写不好文章的问题核心不在于「输出」,在于输入,没有海量的输入,你很难获得持续、高强度的输出。没有中间的处理,你所能写出的文章就是一篇流水账。输入是阅读,你需要海量的阅读;处理是思想,你需要先在大脑内进行思维的碰撞,找出自己想法中的合理与不合理。输出是成文,将处理的结果整理成一篇洋洋洒洒的文字。

如果你对本文有什么看法,欢迎你在文章下方评论,或点击阅读原文前往知识星球参与讨论