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閱讀 229,836評論 6 540
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 99,275評論 3 428
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 177,904評論 0 383
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,633評論 1 317
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 72,368評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,736評論 1 328
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,740評論 3 446
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,919評論 0 289
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,481評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 41,235評論 3 358
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,427評論 1 374
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,968評論 5 363
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,656評論 3 348
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 35,055評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,348評論 1 294
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 52,160評論 3 398
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,380評論 2 379

推薦閱讀更多精彩內容

  • 1. “哐”的一聲,門關上了,哥哥走了。 我睜開眼睛看著安靜的天花板。其實我早就醒了,一直在裝睡,只是不想和...
    燎之方揚閱讀 654評論 0 1
  • 船停在碼頭是最安全的,但那不是造船的目的;人待在家里是最舒服的,但那不是人生的追求。回首過往你會發現,最清晰的腳印...
    伽思珂閱讀 109評論 0 0
  • 攔截器攔截器的操作是基于aop的攔截器的定義:定義攔截器實現HandlerInteceptor接口,接口中三個方法...
    MsterKerrigan閱讀 331評論 0 1
  • 如果有一對coulpe,能夠被全班同學羨慕和祝福,那應該真的就是傳說中的郎才女貌,他們就是久哥和小楠姐。 1 大部...
    Fred_young閱讀 966評論 0 3