我写了一篇《给程序员的中文写作指北》

2020-07-06 13:30:45 +08:00
 KalaSearch

看到有很多 v2 小伙伴都在写博客,而我之前也是博客(搭建)大军里的一员。时间都用在搭 wordpress 上了,真正的输出没多少。最近静下心来,结合之前在知乎写答案的经验,写了一些文章

我发现中文世界里有关程序员写作的教程类文章非常少,但其实写作对程序员非常重要。

于是,我写了这篇

=> 《给程序员的中文写作指北》

从内容、排版和行文三个角度,给出了一些给程序员的中文写作“指北”建议

我自信,如果你能按其中的建议坚持,结合你自己的实践,很快就可以开始写出丰满且吸引人的内容。希望能帮到同样需要写作的你们

文章比较长,建议收藏后慢慢看完。如果你也写博客的话,不妨在回复里留下你的博客链接,我们互加个友链吧!

以下是前言,全文请到移步: https://kalasearch.cn/blog/writing-guide-for-programmers/

作为一名程序员,我们的本业让我们绝大多数的时间都在埋头写代码。

但很多时候,不管你在自己创业还是在公司搬砖,光是代码漂亮是不够的。很多时候,特别是当你需要展示你的想法或者说服别人的时候,好的文章、设计文档至关重要。

比如说,如果你在公司搬砖,在新做一个稍大型一点的系统的时候,设计文档写得怎么样可能直接关系这个项目是不是会被孵化。而如果你在自己创业,能写出好内容则更加重要——毕竟你要说服陌生人购买你的产品、使用你的服务,首先你的潜在用户需要通过你的清晰表达来了解你在做什么,你的产品能帮他们解决什么问题。

就算你对写风花雪月不感兴趣,那你总得偶尔写一些技术文章、交接文档。就算纯技术相关的内容,也需要刻意地练习,才能写得清楚漂亮。不知道你有没有注意过,多数优秀的项目不光代码优秀,文档也非常棒。这里说的漂亮不光是排版规整,行文也流畅且自然。

不幸的是,作为程序员的我们,一旦文章不漂亮,第一直觉想起来的事不是调整文章,而是调整 CSS 和页面布局。页面怎么摆固然重要,但文章本身如何,才是根本。毕竟你的读者都是人,而不是读 html 的计算机。

之所以我把这篇文章标题起为“给程序员中文写作指北”,是因为两个原因

我自己是程序员,我也不知道怎么写小说,但技术文章我写了不少。因此我的观点只适用于程序员群体 “指北”而非“指南”是因为这些也只是我自己的经验总结,不同人肯定有不同的意见。而太主观的观点在我看来,不适合写一份“指南”作为黄金标准 正因为此,如果你读到与自己习惯完全相左的内容,不用担心,也许那样的习惯更适合于你。但总体上,有一些放诸四海皆准的原则,比如段落不宜太长,比如不要中英标点混用等等。总之,希望大家各取所需,根据自己情况调整就好。

余下全文: https://kalasearch.cn/blog/writing-guide-for-programmers/

14316 次点击
所在节点    分享创造
69 条回复
alpha4zeta
2020-07-17 13:50:30 +08:00
@KalaSearch 🤦‍♂️好久没发回复, 已经补上站点了~
KalaSearch
2020-07-17 13:58:18 +08:00
AllenHua
2020-07-17 14:04:15 +08:00
@KalaSearch #22 一定一定
barrysn
2020-07-17 14:32:02 +08:00
@KalaSearch 我觉得大多数技术人员的最大的写作问题是,因为 “知识的诅咒”的原因,讲不清楚自己想要表达的东西
KalaSearch
2020-07-17 14:36:44 +08:00
@barrysn 第一次看到这个词,搜了下,很有意思,感谢

是的,很多时候我写文章要反复跟自己强调:如果需要读的面广的话,需要把 context 讲清楚

即使写论文的时候也有个 introduction 嘛 :)
berrx
2020-07-17 15:21:13 +08:00
关于标点符号这个, 因为方便写代码我把电脑设置成默认英文标点了, 但是这样会让标点符号看起来不明显, 我的做法一般是在英文标点后再加一个空格这样...
YvesX
2020-07-17 15:22:14 +08:00
技术文章不是文章,甚至可以说,科学写作与文学创作在许多方面根本背道而驰。
中文技术文章以面无表情为乐趣,副词连副词,克制加克制,许多根本就是结构一泡污的文档。
shaopu
2020-07-17 15:38:51 +08:00
仔细看了下,我现在写作的风格好多跟楼主写的一样
AllenHua
2020-07-17 15:42:02 +08:00
@KalaSearch #22 楼主,已加你的哦 https://hellodk.cn/friends-sites
lazyyz
2020-07-18 10:51:11 +08:00
看了大佬的文章,我觉得是时候把自己吃灰的博客捡起来了
KalaSearch
2020-07-18 10:56:59 +08:00
@lazyyz 过奖了

多写写博客对程序员职业生涯的确有帮助,快捡快捡 :D
bigyezi
2020-07-18 12:26:56 +08:00
感谢楼主
AFuture
2020-07-18 14:14:43 +08:00
内容受教了。
Soar360
2020-07-20 15:00:15 +08:00
https://www.coderbusy.com/
码农很忙
大佬多多指教
KalaSearch
2020-07-20 15:11:14 +08:00
@Soar360 已加,正在 build,大概 15 分钟之后可以看到了。

请帮忙加上 卡拉搜索 链至 kalasearch.com
Soar360
2020-07-20 15:19:50 +08:00
woostundy
2020-07-20 20:46:30 +08:00
博客很棒。
KalaSearch
2020-07-21 00:33:00 +08:00
@woostundy 感谢<3
scnace
2020-07-21 00:52:30 +08:00
有写给程序员的 PPT 制作指北嘛(逃
KalaSearch
2020-07-21 01:08:28 +08:00
@scnace 做 PPT 不光要会讲故事了,还得审美强。后者我差了一截,没法写 T_T

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/687549

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX