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

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 条回复
JiangTianZheng
2020-07-06 13:56:41 +08:00
居然不知不觉看完了。比李笑来老师的写作课更贴近码农。

发现了宝藏站,收藏了。
kdwycz
2020-07-06 14:28:10 +08:00
博客不错,希望能支持下 rss 订阅
KalaSearch
2020-07-06 15:36:30 +08:00
@kdwycz 感谢!

好的,尽快搞一下,你的博客也有 rss 吗?
KalaSearch
2020-07-06 15:36:45 +08:00
@JiangTianZheng

谢谢!
storypanda
2020-07-06 15:40:50 +08:00
@KalaSearch 我的博客也有 rss
KalaSearch
2020-07-06 15:46:36 +08:00
@storypanda 赞!大佬换链吗?
storypanda
2020-07-07 03:24:53 +08:00
KalaSearch
2020-07-14 12:30:45 +08:00
raaaaaar
2020-07-17 12:37:18 +08:00
多分段,和段落间空一行
KalaSearch
2020-07-17 12:39:40 +08:00
@raaaaaar 好建议,段落长度也有讲究
SteveZou
2020-07-17 12:51:23 +08:00
很有用
becauseOf
2020-07-17 12:54:55 +08:00
已收藏
kop1989
2020-07-17 13:05:50 +08:00
赞了,非常棒
AllenHua
2020-07-17 13:20:08 +08:00
很棒 谢谢楼主赐教

可以加个友链吗 (我今晚 23:59 分之前加你的)

Allen Hua Site: https://hellodk.cn
swieer
2020-07-17 13:25:01 +08:00
指北比指南逼格高点吗
KalaSearch
2020-07-17 13:36:59 +08:00
@AllenHua 好的,加上以后请 ping 我,我会第一时间链到 https://hellodk.cn/
KalaSearch
2020-07-17 13:37:33 +08:00
@swieer 没有,文章里有写,主要是会有主观意见所以不好意思指南
alpha4zeta
2020-07-17 13:39:16 +08:00
楼主可以加下友链吗, 我的站点:
KalaSearch
2020-07-17 13:41:48 +08:00
@alpha4zeta 你的站点好像打漏了 T_T
alpha4zeta
2020-07-17 13:42:20 +08:00
楼主可以加下友链吗, 我的站点:
Herbert's Blog: http://blog.herbert.top/
已经加上了你链接~

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

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

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

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

© 2021 V2EX