关于技术写作的一点碎碎念

秋水文章不染尘。

图片来自 杨振宁传:规范与对称之美

这是杨振宁先生评价保罗·狄拉克文章的一句话,意思是“文章极致纯粹,不含一点渣滓。”
我非常欣赏这句话,并认为这是应该追求的写作境界,值得学习并指导实践。

后来发现这句话也导致了我文章经常性的难产,只得作罢,跟自己妥协了。

差不多就得,因为“道可道,非常道。“你一边写,可能想法就变了,还要从头再改一次;几个PDCA循环下来,文章不就难产了。

所以有的时候不要那么追求纯粹,这样写文章才能一气呵成,这样写的文章有的时候会有种“质朴感”,更能打动自己,和可能打动读者。

“把秋水文章不染尘”放在心里就好,不要过于拘泥最终文章的简洁而牺牲灵感和写作思路的连贯。技术文章,主要目的是让自己有个阶段性的总结,同时又能给读者带来启发,把观点表达清楚就好了,毕竟不是写论文,要处处严谨,结构精妙无杂质。

水完玄学,还是谈谈写作方法写作工具

Markdown写作

Markdown 写作的好处很多,可以参考之前发表于我派的文章。
在本文中要着重强调的 Markdown 写作的好处是“干湿分离“——让你写作时专注于内容,而不需要过多考虑排版和样式。

当初选择来少数派来写专栏有两个原因,一个是因为少数派的排版很漂亮,阅读体验特别好(我自己也一直在做中文互联网技术文章分享的探索);二一个是因为老麦,虽然未曾谋面,但我相信有机会能请老麦小酌一杯,有东北创业者神交之感(此段彩虹屁,辛苦编辑后台推送@老麦)。

文章用Markdown写好了,复制粘贴少数派,简单编辑发布即可,我派就自动帮你渲染成一篇美文了(少数派用的是富文本编辑器,但也非常好用)。

用其他框架也非常方便,使用方法和在少数派发表是类似的。比如发布自己的博客,一般就是把MD放在posts文件夹就可以了(需要加入一些微调,详见相关博客教程)。

Markdown写作工具首推Typora,配合VLOOK插件使用更佳

现在也有一些平替产品,比如Neonity最近在折腾的bluestone(青石笔记)(在阮一峰大的科技爱好者周刊发现,这也是一个发现新玩具的靠谱消息源)

 

Markdown MD文件管理

MD文件管理首推Obsidian(黑曜石)

OB的使用是我今年的一个写作重点,用了太多管理.MD文件的工具了,OB是最有价值和潜力的,希望自己折腾笔记的经验能帮大家合理避坑。

先在这里卖个关子,谈几点OB使用之禅(Zen of OB)

  • OB是个专门为MD笔记管理而优化VS Code,你可以把它看做专为写Markdown笔记而生的代码编辑器或本地化的Chrome浏览器
  • OB学习曲线比较平滑,同时功能非常强大。简单学习就可以在OB里流畅地记MD笔记了,而且天花板非常高,你能用OB解决很多问题
  • OB101 - 官方帮助手册和开发文档,都写的很好很全很细,无论对于新手入门还是老手进阶都很有帮助,唯一门槛是英文,这也是我为什么要推荐大家一定要学好英文的原因。今后我会尝试翻译和搬运一些文档,但个人精力有限,只能做部分摘录精选
  • PKMer.cn强烈推荐,可以学到很多OB和PKM知识管理的相关技巧和知识。关于OB的一切,这里都几乎可以找到中文帮助
 

最后一个倡议

pic from unsplash

我的中学语文老师教过我,说写文章应该像女人的裙子,越短越精彩

和我派的创作者们共勉,祝大家新年更高产,输出更多优质内容,也能收获更多