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

Foreword

工作環境可以在很大程度上影響一個人的成長。在我看來,可以從三個方面來體會:

  1. 客觀環境,即工作需求、職責和任務,也就是實際的日常工作,需求可以驅動學習;
  2. 人文環境,即周圍的同事,當一群優秀的同事環繞在周圍時,你總能從他們身上學習到很多東西;
  3. 文化環境,即公司文化氛圍,身處開放、自由的氛圍中,既有工作幸福感,也有更多嘗試的機會。

自從 2017 年加入 PingCAP 做 Technical Writer 後,接觸和學到了很多新東西。這裡跟大家分享幾個我日常工作中經常使用的小工具,使用體驗蠻好。

瞄了一眼,大部分都是來 PingCAP 之後開始接觸或使用的,其中不少是同事推薦的,在此表示感謝,順便把這些小工具分享給更多的小夥伴。

  • Part 1:寫作工具
    • MacDown
    • Visual Studio Code
  • Part 2:語法拼寫檢查工具
    • Grammarly 插件
    • Code Spell Checker 插件
  • Part 3:截圖標註工具
    • 微信截圖快捷鍵
    • Fireshot 插件
    • Mac 自帶截圖工具
  • Part 4:思維導圖工具
    • XMind
    • 幕布

Part 1:寫作工具

  • MacDown
  • Visual Studio Code

MacDown 和 Visual Studio Code (VS Code) 是我經常使用的編輯工具,用於編輯 .md (Markdown) 格式的文件。這種極簡的編輯工具可以幫你專註於內容。VS Code 比 MacDown 強大很多。

如果你對 Markdown 不熟悉,或者使用的不是 macOS 而是 Windows,可以戳我之前寫過的兩篇文章,其中已較為詳細地介紹過 Markdown 編輯器和 VS Code。

  • 快速了解 Markdown、基本語法和編輯器:MacDown
  • 快速了解 Visual Studio Code

如果是寫私人博客文章,目前(說不定之後會換)我一般會先用 MacDown 來寫,因為夠簡潔。在左側編輯,右側可以實時預覽。舉個栗子,當前這篇文章的編輯頁面如下:

如果是日常工作,我一般使用 VS Code。喜歡它的以下幾點:

  • 它有一個強大的插件帝國,支持很多插件。例如:英語單詞拼寫和語法檢查、Markdown 語法檢查、自動生成目錄、表格格式檢查等。
  • 可以查看當前編輯位置是在第幾行。修改文檔時經常用到,方便定位。
  • 可以一次打開一個文件夾,方便同時對多個文檔進行修改。

VS Code 編輯界面如下所示,還是蠻炫酷:

寫上一篇提到 VS Code 的文章時,它的 Logo 是黃色,後來聽取用戶反饋,又改回了藍色。

Part 2:語法拼寫檢查工具

  • Grammarly 插件
  • Visual Studio Code 插件

語法檢查工具 | Grammarly 插件

Grammarly (https://www.grammarly.com) 是一款免費的語法檢查工具,可以直接添加為 Chrome 插件。這樣你再在網頁上輸入文字時,可以看到右下角會有一個綠色的 Grammarly 圖標,會及時提醒輸入字元的語法錯誤。

舉個栗子,在 Chrome 瀏覽器中打開 GitHub 和微信公眾平台的編輯頁面,可看到綠色的小圖標,如下所示:

GitHub 編輯頁面

微信公眾平台編輯頁面

在 Chrome 瀏覽器的擴展項里搜索 "Grammarly" 添加至擴展即可。如下所示:

Visual Studio Code 插件:Code Spell Checker

在支持無數插件的 VS Code 里搜索安裝一款語法檢查插件即可,我用的是 Code Spell Checker,使用體驗還不錯。在左側插件搜索欄里搜索 "Code Spell Checker" 或者 "spell" 即可找到。

Code Spell Checker 會即時地用下劃波浪線標註拼寫錯誤,同時還有一個小燈泡給你提示建議修改成的一些選項,如下所示:

Part 3:截圖標註工具

  • 微信截圖快捷鍵
  • 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 自帶的截圖功能還是可以一用。

Part 4:思維導圖工具

  • 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-

推薦閱讀:

賦能與進化,人工智慧2017

TAG:實用工具 | 技術 | 寫作 |