扫码阅读
手机扫码阅读

写在技术专栏的发布之后

63 2024-03-02
五月初的时候我在GitChat发布了一个专栏,讲微服务实战(基于Spring Cloud Aibaba),近期也是因为忙项目,懒惰了,文章没写几篇,这次就借机聊聊写作专栏这件事。
为什么写专栏,还是想做一些具有可复制性的东西,一次固定投入,边际成本很低。其实不只是专栏,任何具这种特性的事物,都值得我们去尝试。
我骨子里其实还是想撺本书的,自打写公众号以来,也有不少编辑也联系过我,一是书籍多偏技术方向,另外一个自己积累还不够,一直也没敢应承。年前一次偶然机会,与金蝶的老同事华哥聊天,他说正在准备一个专栏要发布到GitChat去,这一下激起了潜在已久的兴趣,随即要了平台方的联系方式,自此开始了一段微服务实战入门实操课程的写作历程。
过程呢与软件工程步调一致:做需求分析,拆任务,做设计,搭环境,写代码,搞测试,再形成文章,一篇接一篇。这是一个人全流程参与的过程,也是锻炼读者参与度的过程,与敏捷过程中提倡的“多面手”有异曲同工之妙。
为什么写这个选题?早先就写过一个微服务的入门示例,名为Simplemall,一个简单的购物交易,发布在Github上,现在也有660+star ,时不时还会有小伙伴问一些相关的问题。不足之处在于没有文档说明,只能靠大家去读代码。另外组件版本也比较老,没时间去更新。
借此机会,可以尝试下新的Spring Cloud新组件——Spring Cloud Aibaba,结合一个大家相互熟悉的商场停车收费场景中,将敏捷思想,软件过程也都融入进去,大概篇幅有24篇,算是入门。
与编辑确定选题、个人信息后,就进入了内容创作部分,编辑同学从她的角度提了不少意见,而这正是我写此篇文章的用意所在,分享给大家,也是自己随意写文章时欠缺的东西。
  1. 输出的内容要从读者的角度出发,不能从写作人的视角写,这样不利于读者阅读学习。
  2. 要能把对读者有利的东西摆出来,而不是自我为什么要写这个东西,可能读者也不关心你为什么写
  3. 内容要有衔接性,章节之间有个过度衔接,方便读者可以快速切入上下文环境,不至于读起来很突兀。
  4. 文中引用的东西,不管是图片还是文字,尽量有来源,这也是对来源作者的尊重,如果有可能,尽量自己原创最好。
  5. 多使用图表,少写字。图表更容易被识别阅读,而文字往往会很枯燥,一图胜千言,目的是为了将东西交代清楚,方便读者快速学习掌握。
  6. 内容输出质量要有保证,基本的行文规范还是要有的,比如中英文混编时,中间要有空格。行文的数量要有保证,太短无法承载一个专栏的体量。
  7. 目录与开篇,基本上就决定了读者会不会买账,所以这两部分是关键所在,需要多打磨。
纯粹写自嗨的文章没有问题,写出让读者喜闻乐见的文章的就复杂的多,所以专栏写作不是一个纯粹的技术过程,这是一个与编辑合作的过程,与读者交流的过程,与自己重新对话的过程。文章是写过不少,但去写一个多达20多篇的系列文章也是头一遭,好在有一点点写作的底子,不担心写不出来。
专栏内容还算比较贴合当下的技术氛围,更希望通过一杯咖啡的费用基本掌握到各个组件的融合应用,以及整个软件过程的分析过程,相信对一些小伙伴还是有帮助的。
你在各个平台上所能看到的其他老师的课程,都是一点一滴打磨出来的,一篇文章、一个视频、一个动图,背后可能就是数个乃至数十个小时的努力,凡是经历过的人,相信都能从中成长不少。我还在酝酿一些新的东西,希望一样保持继续写的态势,做个一直滚下去的雪球。

原文链接: http://mp.weixin.qq.com/s?__biz=MzIwMjE3MDIwMA==&mid=2247486173&idx=1&sn=19baf2e078bd929688323351e36cb0de&chksm=96e380eaa19409fc88b022453ad5ebc5f51eb286808e26b9d1b3912e4a2b3c7e610ab5f6c4cc#rd