文章目錄
  1. 1. 問好問題寫好文件
    1. 1.1. 同時和多人進行非同步的溝通
    2. 1.2. 一次撰寫,到處使用 (Write Once Use Everywhere)
  2. 2. 寫好文件的訣竅
    1. 2.1. 文件的好處
    2. 2.2. 確立文件目的
    3. 2.3. 定義對象
  3. 3. 如何問好問題
    1. 3.1. 針對問題事前準備
    2. 3.2. 描述問題的技巧

問好問題寫好文件

問好問題和寫好文件可以說是職場必點技能,對技術人員來說人雖然會離開但要讓知識可以留下來。在進入職場後,不管是在新人培養、部門技術分享、專案規格溝通甚至是離職交接,問好問題和寫好文件都是一定要點滿的技能,這個部分做得越好,團隊運作就會更順暢。

同時和多人進行非同步的溝通

當然面對面有無法取代的好處,但我認為技術相關畢竟是密度較高的訊息,口語的溝通比起文件溝通又更難一些,為什麼口語又更難,因為文件可以附上參考資料,口語還要在訊息投放時針對受眾即時的進行轉譯和客製化,也就是花很多時間降維到足夠對方吸收為止,且還要確認對方理解後才能繼續往下。

寫文件的好處是花時間寫好一次就可以同時跟很多需要資訊的人進行溝通,而不需要在受限制的時間、地點下進行有失敗機率的訊息同步,文件原則上一群人有八成能看懂我們就不需要再花時間處理剩下兩成,除非那兩成是你的老闆。

寫好文件會有哪些好處?

  • 同時和多人進行非同步的溝通
  • 撰寫一次卻能到處使用

一次撰寫,到處使用 (Write Once Use Everywhere)

職場上的文件有另外一個顯而易見的好處,就是能夠一稿多投。

舉例來說為了讓同事一起成長而決定在部門內分享新知或是專案處理方式,不但可以正大光明用上班時間來做自己想做的事情,還可以順便當作提早離職交接的概念,因為到時候離職也是可以講同一份文件,寫好一份文件,我最常一稿多投的情境有

  • 進度報告
  • 讀書會知識分享
  • 專案回顧
  • 離職交接

寫好文件的訣竅

寫好文件其實我覺得不太困難,大家從小到大都寫了很多報告,但到了職場之後卻又把過往的訓練拋棄我覺得有點可惜,長久下來,我認為一份好的文件確認兩個重點通常就能夠有不錯的表現:

  1. 文件目的
  2. 讀文件的對象

文件的好處

相信大家會來看這個部落格,大部分都是在網路或科技相關領域工作,所以就先用工程師的角度來談談,文件之於專案進行就像是框架之於應用開發,對工程師來說使用框架有什麼好處?

  • 省時間: 不用再研究和交代基礎建設類問題,離職交接很快
  • 學觀念: 能透過框架學習準則,了解目前業界遇到了什麼問題
  • 抄作業: 通常框架說明書也會提供 Best Practices

其實相關的優點是類似的,對於專案進行,文件有什麼好處?

  • 省時間: 如果同樣一份文件給所有人看,只有一個人看不懂? 我們找出瓶頸就很棒了,剩下讓能處理的處理?
  • 學觀念: 看過前人遺毒後,能了解公司遇到問題是怎麼解決的
  • 抄作業: 寫完一遍可以廣泛用在各種教育訓練、離職交接、進度報告文件上

確立文件目的

  • 為什麼要寫這份文件?希望達成的目標與結果是什麼?
  • 這是一份主要文件、還是參考文件?

了解文件背後的目的:

  • 最重要的是持續維持大家的 context
  • 事前少量揭露,事後的總結
  • 確認對方想法
  • 確認議題結束
  • 為何而做,最終又想影響什麼

定義對象

訊息的投放不管在哪種領域中,針對對象優化都是一門課題,底下是動筆前值得思考的問題:

  • 誰會看這份文件?
  • 如何使用這份文件?
  • 預期在這份文件得到哪些資訊?
  • 習慣的文件格式是什麼樣子?

舉三個例子:

  1. 對象是 PM: 文件的目的是要協助對更上層交差,透過總結列點、淺顯易懂的說明、運用圖文穿插就會是較好的文件撰寫方式。
  2. 對象是接手工程師: 有沒有辦法透過文件在半天內將所有開發需要的知識和步驟了解過一遍,這個部分可以參考開源專案常見的 README.md 或是 Quick Start Guide,重點就是拿掉多餘的訊息,列下關鍵步驟,剩下的生命會透過參考資料自我補上。
  3. 如果是教學型的文件,舉例來說就像是部落格文章,我個人覺得要提供適合複製貼上還有關鍵步驟的圖文是最好的,如果能附上完整的參考資料讓我們學習後可以了解更多會更棒。

寫好文件被誇獎其實也會有成就感
doc-quick-start

如何問好問題

我大部分時候其實比較習慣自己做事情,有時候也會覺得自己一個人做的效率比起大家一起還要更好一些,所以曾經也很不會問問題,是在遇到聰明的同事、學長姊後才慢慢開竅,以前更不會透過對話練習讓其他人能夠問對問題。

問好問題跟打電動破關的概念其實是相通的,如果打電動前我們可以得到相關攻略、密技,在遊戲遇到困難時就能夠更容易去處理,通常我們都是為了到達一個目標而想要問問題,而問好問題就是一個破關的過程,在過程中的攻略就是我們需要針對問題做好事前準備,而秘技則是掌握問問題的相關技巧。

問好問題會有哪些好處?

  • 節省雙方的時間
  • 更快得到想要的答案

針對問題事前準備

通常請教的對象會理解的比你多,而對方可以從問題中了解你到底為了這個問題準備了多少或做了哪些嘗試,以資訊領域來說我認為問問題前,可以先做到的事情:

  1. 用 Google 關鍵字搜尋答案
  2. 搜尋官方文件、常見問題文件(FAQ)
  3. 到相關論壇搜尋
  4. 嘗試先自己檢查或實驗來找到答案
  5. 加入相關社團或群組爬文
  6. 看原始碼
  7. 萬事問臉書的發文

網路上有一篇極為經典的教學 “提問的智慧“,我認為資訊領域如果沒有讀過,真的應該要好好拜讀一波 XD

描述問題的技巧

工程師在專案的進行中很常會碰到其他部門的人反映目前專案的功能出現問題,最大的困擾卻是需要 Cosplay 通靈王,網路上這篇神作 “如何有效地報告錯誤“,也非常推薦!!!一定要讀!!!

  • 定義和拆解問題
    • 覺得上班有種被困住的感覺,所以請問是心靈感覺被困住還是身體被困住?
  • 仔細、清楚描述問題
    • 環境: 機器配置、作業系統、應用程式、以及版本號相關的資訊
  • 描述自己是怎麼研究和理解這個問題
    • 為了確定問題有做了哪些步驟
    • 嘗試過哪些解決方法
    • 最近是否有做過什麼變更,不管是硬體或軟體?
  • 該怎麼重現這個問題的,包含環境設定和步驟

喜歡這篇文章,請幫忙拍拍手喔 🤣

share