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

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

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

• 如果你在大厂，升职加薪可能不光靠代码，还需要写合格的设计文档
• 如果你在创业，需要写内容来吸引用户的话，就更不用说了。
• 哪怕你只是业余写定博客，写出好的文章也是你树立个人品牌，吸引读者从而促使你长期坚持的必要条件。

于是，我写了这篇

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

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

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

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

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

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

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

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

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

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

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

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

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