Technical Writer 日常工作中好用的小工具

Foreword

工作环境可以在很大程度上影响一个人的成长。在我看来,可以从三个方面来体会:

  1. 客观环境,即工作需求、职责和任务,也就是实际的日常工作,需求可以驱动学习;
  2. 人文环境,即周围的同事,当一群优秀的同事环绕在周围时,你总能从他们身上学习到很多东西;
  3. 文化环境,即公司文化氛围,身处开放、自由的氛围中,既有工作幸福感,也有更多尝试的机会。

自从 2017 年加入 PingCAPTechnical Writer 后,接触和学到了很多新东西。这里跟大家分享几个我日常工作中经常使用的小工具,使用体验蛮好。

瞄了一眼,大部分都是来 PingCAP 之后开始接触或使用的,其中不少是同事推荐的,在此表示感谢,顺便把这些小工具分享给更多的小伙伴。

  • 写作工具
    • MacDown
    • Visual Studio Code
  • 语法拼写检查工具
    • Grammarly 插件
    • Code Spell Checker 插件
  • 截图标注工具
    • 微信截图快捷键
    • Fireshot 插件
    • Mac 自带截图工具
  • 思维导图工具
    • XMind
    • 幕布

写作工具

  • MacDown
  • Visual Studio Code

MacDown 和 Visual Studio Code (VS Code) 是我经常使用的编辑工具,用于编辑 .md (Markdown) 格式的文件。这种极简的编辑工具可以帮你专注于内容。VS Code 比 MacDown 强大很多。

如果你对 Markdown 不熟悉,或者使用的不是 macOS 而是 Windows,可以戳我之前写过的两篇文章,其中已较为详细地介绍过 Markdown 编辑器和 VS Code。

如果是写私人博客文章,目前(说不定之后会换)我一般会先用 MacDown 来写,因为够简洁。在左侧编辑,右侧可以实时预览。举个栗子,当前这篇文章的编辑页面如下:

如果是日常工作,我一般使用 VS Code。喜欢它的以下几点:

  • 它有一个强大的插件帝国,支持很多插件。例如:英语单词拼写和语法检查、Markdown 语法检查、自动生成目录、表格格式检查等。
  • 可以查看当前编辑位置是在第几行。修改文档时经常用到,方便定位。
  • 可以一次打开一个文件夹,方便同时对多个文档进行修改。

VS Code 编辑界面如下所示,还是蛮炫酷:

写上一篇提到 VS Code 的文章时,它的 Logo 是黄色,后来听取用户反馈,又改回了蓝色。

语法拼写检查工具

  • Grammarly 插件
  • Visual Studio Code 插件

Grammarly 插件

Grammarly (https://www.grammarly.com) 是一款免费的语法检查工具,可以直接添加为 Chrome 插件。这样你再在网页上输入文字时,可以看到右下角会有一个绿色的 Grammarly 图标,会及时提醒输入字符的语法错误。

举个栗子,在 Chrome 浏览器中打开 GitHub 和微信公众平台的编辑页面,可看到绿色的小图标,如下所示:

在 Chrome 浏览器的扩展项里搜索 "Grammarly" 添加至扩展即可。如下所示:

Visual Studio Code 插件:Code Spell Checker

在支持无数插件的 VS Code 里搜索安装一款语法检查插件即可,我用的是 Code Spell Checker,使用体验还不错。在左侧插件搜索栏里搜索 "Code Spell Checker" 或者 "spell" 即可找到。

Code Spell Checker 会即时地用下划波浪线标注拼写错误,同时还有一个小灯泡给你提示建议修改成的一些选项,如下所示:

截图标注工具

  • 微信截图快捷键
  • Fireshot 插件
  • Mac 自带截图工具

微信截图快捷键

在一位同事推荐之前,我没有用过微信自带的截图快捷键,只用过聊天窗口的截图小剪刀。用过之后,相见恨晚。

在 PC 端登录微信客户端之后,便可以愉快地使用它的截图快捷键了,默认是:Command+Control+A。当然,你也可以在设置里面自定义快捷键。

微信截图快捷键有以下几个友好的功能:

  1. 截图后可调整边缘或大小,可整体移动。这点很重要,因为有时边边角角的需要调整得好看一点,以及万一手抖截多了或截少了。
  2. 截图后可取消。这点也会经常用到,有时截错了,或者截了不想要了,或者突然想起截另一处更好。
  3. 支持框型和箭头标注。这也是两个频繁用到的功能。
  4. 此外,还可插入文字标注,支持选择颜色,支持马赛克等。

总之,使用体验非常不错,轻便、快捷、友好。

Chrome 插件:Fireshot

这款 Fireshot 插件是同事 PiPa君推荐给我的,试用之后很是喜欢。强烈推荐!

在 Chrome 的扩展程序里搜索添加即可。它的图标是一个总让我想起搜狗的字母 S。

用它截全屏简直不能更爽,直接点击小图标,选择截全屏即可自动截取浏览器书签栏以下的全部内容。

https://pingcap.com/en 这个页面为例,点击图中的 "Capture entire page"。

数秒之后,便会打开一个新的页面,保存你需要的格式即可。如下所示:

保存为图片,默认 PNG 格式,效果如下:

Mac 自带截图工具

在使用上述两款截图工具之前,我还是会经常使用 Mac 自带截图功能的。然而,自从使用上述两款之后,我就渐渐冷落它了,偶尔用一下。

Mac 自带的截图快捷键为 Command+↑+4。使用一段时间后,觉得它的优点已无法说服我容忍它的缺点。

  • 优点:很快。按下快捷键,选定区域后,瞬间保存至桌面。
  • 缺点:选定截图区域后不支持调整、取消、标注这些常用的基本功能。最开始我还用 Mac 的 Preview 打开截图文件,使用里面的标注功能二次处理。

如果你觉得自己手法特别好,一次就能框选得特别完美,而且也不需要标注,那么它很适合你。如果你没在电脑上登录微信客户端,也不需要多么精确的截图,又不想再安装一个第三方工具,那么 Mac 自带的截图功能还是可以一用。

思维导图工具

  • XMind
  • 幕布

XMind

XMind (https://www.xmind.cn/) 是一个受众较为广泛的思维导图软件。

界面简洁美观,分分钟上手。既可以用它来帮助你理清学习内容的脉络,也可以用来规划工作任务。同时,也方便以后快速查找和理解。

XMind 我也曾安装过手机移动端,但使用体验不大好,很快就卸载了。此时,接触了另一款超适合手机端使用的思维导图工具,就是接下来要说的“幕布”。

幕布

幕布 (https://mubu.com) 是一个思维导图工具,接触它是吃了 Queeny 的一发安利。

幕布有以下特点:

  1. 轻便,简单直观。
  2. 弱化格式,让你专注于文字内容,不必费心去调整。
  3. 文字列表和思维导图之间一键切换。
  4. 手机端适配很好,可随时记录灵感,比如在地铁上。
  5. 手机移动端和 PC 端可及时地同步。
  6. 可以生成分享链接,分享给他人。

现在大概很少有人会随时带着纸笔,如果对某件事突然有了想法或灵感时,用它来记录就很方便。

Afterword

如果你还没有用过以上介绍的某种工具,可以根据自己的需求试用一下,让这些小工具的便利帮你提高效率,给你的日常工作或生活增添一丝幸福感。

你可能想读

技术翻译需要有 Technical Writer 的 sense
深度解析关于技术翻译的六个认知误区
如何让你的内容输出更加专业更有设计感?
书单 | 有哪些技术传播从业者必知必看的书籍?
有哪些适合技术传播从业者关注的优质博客?(一)
有哪些适合技术传播从业者关注的优质博客?(二)
英语技术文档的标题到底该大写还是小写?
如何使用正则表达式批量添加和删除字符?
Markdown:写技术文档、个人博客和读书笔记都很好用的轻量级标记语言
如何为 Markdown 文件自动生成目录?
技术写作实例解析 | 简洁即是美
两分钟趣味解读 Technical Writer
若脱离理解,直译得再正确又有何意?
优质译文不应止于正确,还要 Well-Organized
写在入职技术型创业公司 PingCAP 一个月之后
揭秘 Technical Writer 的工作环境 | 加入 PingCAP 五个月的员工体验记

-END-

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,047评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,807评论 3 386
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,501评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,839评论 1 285
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,951评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,117评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,188评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,929评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,372评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,679评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,837评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,536评论 4 335
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,168评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,886评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,129评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,665评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,739评论 2 351

推荐阅读更多精彩内容

  • 1. “哐”的一声,门关上了,哥哥走了。 我睁开眼睛看着安静的天花板。其实我早就醒了,一直在装睡,只是不想和...
    燎之方扬阅读 632评论 0 1
  • 船停在码头是最安全的,但那不是造船的目的;人待在家里是最舒服的,但那不是人生的追求。回首过往你会发现,最清晰的脚印...
    伽思珂阅读 106评论 0 0
  • 拦截器拦截器的操作是基于aop的拦截器的定义:定义拦截器实现HandlerInteceptor接口,接口中三个方法...
    MsterKerrigan阅读 325评论 0 1
  • 如果有一对coulpe,能够被全班同学羡慕和祝福,那应该真的就是传说中的郎才女貌,他们就是久哥和小楠姐。 1 大部...
    Fred_young阅读 946评论 0 3