作为一名成熟的云原生布道师,我是这么写作的
公众号关注 「奇妙的 Linux 世界」
设为「星标」,每天带你玩转 Linux !
技术写作的价值
写作并不是一件轻松的事情,特别是技术内容创作,它不仅需要兴趣来驱动,而且需要耐心,所以写作这个活动注定不适合所有人。我想无论是写作、演讲,还是录制视频,除了利益驱动无可厚非之外,大家肯定都有一个额外的共同目的:分享。
至于分享之后为了得到什么,那都不重要,比如我就是为了满足自己的虚荣心,说白了就是装x,看着自己的文章被越来越多的人阅读,越来越多的人认识我,加我微信好友的人越来越多,自己在圈内越来越出名,虚荣心得到了极大的满足。既满足了自己的虚荣心,又造福了广大读者,有何不可呢?
除了我说的这些,写作还有没有其他价值呢?还是拿我亲身经历举例子,我的一部分文章给我带来了全新的工作机会;还有一部分文章吸引了很多社区和团队的目光,主动来和我合作;所有的这一切让我结识了更多志同道合的朋友;当然,获取到大量关注后也给我带来了更多的收入,这个不必避讳。
听了我的描述后,如果你决定开始尝试写点东西,或者已经开始尝试一段时间,但还是没有明确的思路,这篇文章就是为你们准备的。
声明:虽然今天这篇文章是教大家如何写云原生领域的文章,但实际上是通用的,并不局限于云原生,只要你想写作,这篇文章都有一定的参考价值。
写作工具
工欲善其事,必先利其器。既然决定了进入“写作”这个战场,首当其冲的就是选一件称手的兵器,对于写作来说,这个兵器就是“写作工具”。选工具之前,先要明确一下自己偏好的排版格式,目前有两种主流的排版格式:
富文本:富文本格式(Rich Text Format, 一般简称为 RTF)是由微软公司开发的跨平台文档格式。最大的特点是:所见即所得,你把格式调整成什么样子,就会直接显示出什么样的效果。这一点和 Word 类似。目前微信公众号文章就是通过富文本来编辑的。
Markdown:Markdown 是一种轻量的标记语法,你可以理解为一种伪编程语言,和 HTML 有点像,只不过是专门为写作准备的极简格式。Markdown 的语法很简单,只有一些简单的符号,我们只需学习这几个简单的符号,然后插入到写作内容中,不用关心排版。
程序员大多都不喜欢使用 Word 这类富文本编辑器,因为不可控因素太多,各种形式、用法和风格,而且花样繁多,强依赖于编辑器,换个编辑器用法又不一样了。
众望所归的选择还是 Markdown,排版都是可复制的,文字的排版只是多打几个符号而已,最终产出的只是一个纯文本,非常利于传播和迁移。所以 Markdown 才是程序员的最爱。
目前市面上比较流行的 Markdown 编辑器琳琅满目,本文也无法为大家一一介绍,这里只推荐几个我认为最最最优秀的。
Typora
Typora[1] 最吸引人的特性就是它的即时渲染,也就是所谓的所见即所得。一般的 Markdown 编辑器都分为编辑栏和预览栏,Typora 将其合二为一,实时预览,只要你敲入相应的标记符号就立马为你转换为对应的样式,就像写 Word 一样流畅自如。这是本文在 Typora 中的排版样式:
遗憾的是 Typora 目前已经开始收费,但这是合理的,之前 Typora 发布的都是测试版,免费供大家使用,现在正式版开始取消免费,毕竟开发也需要付出,我们要尊重开发者,优质的产品值得付费。我们可以选择不用 Typora,但不必对其收费行为冷嘲热讽。
VS Code
VS Code[2] 虽然是一个代码编辑器,但由于它的功能过于强大,插件过于丰富,扩展性极强,所以人们也常常用它来写作。
Visual Studio Code(简称 VS Code)是一个由微软开发,同时支持 Windows 、 Linux 和 macOS 等操作系统且开放源代码的代码编辑器,它支持测试,并内置了 Git 版本控制功能,同时也具有开发环境功能,例如代码补全(类似于 IntelliSense)、代码片段和代码重构等。该编辑器支持用户个性化配置,例如改变主题颜色、键盘快捷方式等各种属性和参数,同时还在编辑器中内置了扩展程序管理的功能。——维基百科
VS Code 借助插件的力量可以实现和 Typora 旗鼓相当的能力。VS Code 默认情况下内置了 Markdown 的预览功能,效果如下:
要想实现即时预览的能力,就需要借助一款强大的插件:Office Viewer。
这货不但可以实时预览编辑 Markdown,还能显示 PDF 文档和 Excel 表格,简直就是简直了。
装好该插件后,需要在内置文件浏览器里依次右键 --> 打开方式,
然后在弹出的面板中选择 Office Viewer。
最终效果如下:
Obsidian
Obsidian[3] 是一个支持双向链接的笔记管理软件,但我们用它来写 Markdown 也是极好的!Obsidian 最新版本也实现了即时预览功能,只需在编辑器设置中将默认的编辑模式改为即时预览即可。
最终呈现的效果如下:
可以看到其实时预览功能目前还有一些小缺陷,比如引用的样式渲染不太理想,不过后续这些问题都会被修复的,现在只是开始。
关于 Obsidian 作为笔记管理软件本身的强大功能,本文不作过多介绍,感兴趣的可以自己研究。
Hackmd
除了个人创作外,有时我们也需要多人协作编辑 Markdown。即使是个人创作,有时也需要请多人帮忙提出改进建议。如果有这方面的需求,可以使用 Hackmd[4] 来协作。在 Hackmd 中,正在编辑这篇文章的人可以同时看见其他协作者正在编辑的位置,编辑一段文字后还可以看见这段文字是谁写的,不同作者用不同颜色表示在这段文字的左边或者下面。还可以对选中的内容通过留言的形式提出改进的建议。
写作类型
笔者目前工作的领域是云原生,更宽泛一点则是基础架构领域,这个领域的技术内容创作类型大概可以分为以下几类:
问题解决类:该类文章以问题为切入点,整篇文章都是围绕着如何解决这个问题,包括问题的前因后果、问题的解决思路与步骤、避坑方法等。比如这篇:
作为一名成熟的云原生布道师,我是这么写作的相关推荐
- 直播预告 | 对谈谷歌云 DORA 布道师:聊聊最关键的四个 DevOps 表现指标
本期分享 DORA 的全称是 DevOps Research and Assessment,是一个致力于 DevOps 调研与研究的组织,2018 年加入 Google Cloud.自 2014 年起 ...
- DevData Talks | 对谈谷歌云 DORA 布道师,像谷歌一样度量 DevOps 表现
本期 DevData Talks 我们请到来自 Google Cloud 谷歌云的 DORA 研究团队的嘉宾 Nathen Harvey与 Apache DevLake.CNCF DevStream ...
- .NET 云原生架构师训练营(设计原则设计模式)--学习笔记
▲ 点击上方"DotNet NB"关注公众号 回复"1"获取开发者路线图 学习分享 丨作者 / 郑 子 铭 这是DotNet NB 公众号的第180篇原创文章 ...
- .NET 云原生架构师训练营(系统架构)--学习笔记
▲ 点击上方"DotNet NB"关注公众号 回复"1"获取开发者路线图 学习分享 丨作者 / 郑 子 铭 这是DotNet NB 公众号的第176篇原创文章 ...
- .NET 云原生架构师训练营(模块二 基础巩固 安全)--学习笔记
2.8 安全 认证 VS 授权 ASP .NET Core 认证授权中间件 认证 JWT 认证 授权 认证 VS 授权 认证是一个识别用户是谁的过程 授权是一个决定用户可以干什么的过程 401 Una ...
- .NET 云原生架构师训练营(模块二 基础巩固 REST RESTful)--学习笔记
2.3.1 Web API -- REST && RESTful 什么是 REST,什么是 RESTful RESTful API 设计 RESTful 成熟度模型 什么是 REST, ...
- .NET 云原生架构师训练营(模块二 基础巩固 配置)--学习笔记
2.2.3 核心模块--配置 IConfiguration Options ASP.NET Core 中的配置:https://docs.microsoft.com/zh-cn/aspnet/core ...
- .NET 云原生架构师训练营(模块二 基础巩固 日志)--学习笔记
2.2.2 核心模块--日志 ILogger 的使用 日志的 ID 日志的分类 日志的级别 LoggerProvider 日志的最佳实践 .NET Core 和 ASP.NET Core 中的日志记录 ...
- .NET 云原生架构师训练营(模块二 基础巩固 依赖注入)--学习笔记
2.2.1 核心模块--依赖注入 什么是依赖注入 .NET Core DI 生命周期 服务设计 服务范围检查 ASP.NET Core 依赖注入:https://docs.microsoft.com/ ...
最新文章
- 分布式,集中式,云原生存储技术
- 将PS/2接口鼠标改造成USB接口鼠标
- VTK:InfoVis之GraphPoints
- InnoDB和MyISAM有哪些不同
- vue 单文件组件中,输入template 按 tab 键不能自动补全标签的解决办法
- 【入门5】字符串(今天刷洛谷了嘛)
- 身为一个产品经理应该了解自己的本职
- 凿渠造舟:视频会议的昨天与明天
- VB 创建快捷方式函数(可带参数)
- 网上第3方软件教程摘选
- 云游戏真的来了,这次的搅局者是 Google,云游戏平台搭建
- Entity Framework之IQueryable和list本地集合
- 九校联考-长沙市一中NOIP模拟总结
- 矩阵分析(2)--正规矩阵、正交矩阵
- c语言需要什么硬件基础知识,学习c语言需要什么 基础c语言需要这些知识
- 美国MaaS应用如何成功打入法国市场
- 给Office文档加密方式与原理揭秘
- 简单分析大量京东快递揽收后没有物流的单号
- 为什么计算机里没有桌面显示不出来,电脑开机后桌面显示不出来如何修复_电脑开机后桌面没有东西的处理办法-系统城...
- 基于微信小程序菜谱小程序毕业设计开题报告功能参考
热门文章
- 水军为手机应用软件排名造假
- 牛客竞赛小白试炼(20201205 怕npy的牛牛)
- 电路中的 电源 与 接地 的理解
- 无法调用自己电脑的gpu,即torch.cuda.is_available()返回false
- 【读书笔记】《欲罢不能》读书笔记
- ts中箭头函数用泛型表示,6种方法
- 小米手环3 NFC 自定义 门禁卡数据
- 教你用python做个街拍美图手册
- KeyError: ‘[1 2] not found in axis‘
- 关于数据分析,管理者常犯的4个错误
- 直播预告 | 对谈谷歌云 DORA 布道师:聊聊最关键的四个 DevOps 表现指标