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

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/

14083 次点击
所在节点    分享创造
69 条回复
kios
2020-07-21 09:59:47 +08:00
感谢分享
cnrting
2020-07-21 10:20:39 +08:00
这是个月经推广贴🙃
zlu1123
2020-07-21 10:28:10 +08:00
先马后看好习惯
KalaSearch
2020-07-21 11:18:39 +08:00
@kios 不客气 <3

@cnrting 写篇好文章不容易,不推广可惜了

@zlu1123 给你的习惯点赞
warush
2020-07-21 12:23:10 +08:00
大佬带一下:warush.club
KalaSearch
2020-07-21 13:17:17 +08:00
@warush 好的,请帮我把“卡拉搜索”加到你的友链呀

你需要什么锚文本? WA Rush? 我晚上一定加一下

搞 ACM 的看你这 ID 要笑出声
graetdk
2020-07-21 13:51:23 +08:00
卡拉搜索,我提交申请试用,貌似返回了一个 404 ?
KalaSearch
2020-07-21 13:52:27 +08:00
@graetdk 表单处理没搞好,但已经收到了你的申请啦。很快跟你联系 <3
graetdk
2020-07-21 13:56:35 +08:00
@KalaSearch 期待期待!
fenx
2020-07-21 14:10:03 +08:00
博客最近更新位置还以为是目录……
zcxey2911
2020-07-21 17:19:15 +08:00
@KalaSearch 刘悦的技术博客 https://v3u.cn 已经添加贵站
KalaSearch
2020-07-22 13:21:48 +08:00
@zcxey2911 好哒,已加
encro
2020-07-22 15:11:41 +08:00
rss 链接是错的,打不开。。。
encro
2020-07-22 15:13:01 +08:00
https://www.kalasearch.cn/blog/blog/how-to-name-your-startup/

rss 里面的内容是这样,正确的应该少一个 blog
xrr2016
2020-07-22 16:15:11 +08:00
受教了,谢谢。已添加友链 https://coldstone.fun/
Kirsk
2020-07-22 23:30:44 +08:00
附言过于真实 论程序员如何有效的营销自己
KalaSearch
2020-07-23 00:35:24 +08:00
@xrr2016 链回了,你的博客很赞,文章清晰配图也非常美观
KalaSearch
2020-07-23 00:37:03 +08:00
@encro 啊!感谢你的发现!上次改了网站没有改 rss,一会改一下 <3
imn1
2020-07-23 20:44:10 +08:00
@swieer #15
指南通常是“正向引导”,指北是“逆向引导”
逆向不是引导错误的意思,而是指出错误达到引导正确的目的,意思就是纠正、勘误
如果换一种现在常见的说法就是《程序员的中文写作的误区》

还没看文章,不知道是否这个,但指北是这个意思
WytheHuang
2020-07-23 21:01:42 +08:00
收藏了

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

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

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

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

© 2021 V2EX