Hi 我是朱騏 👋 又到了每週給你寫封信的時間啦~
這禮拜我想跟你分享比較硬一點的內容,來自於我在工作上的啟發。
如果你是以下 3 種人之一:
即將進入軟體業工作
軟體團隊上使用 Jira 來管理專案任務
工作上需要參加專案,和同事互相合作
我相信這篇文章,能夠帶給你一些啟發。
先快速跟你說一個消息:
✍️ 我要在五月開一堂實體寫作課了!
我希望透過 7 小時的紮實內容,教你將腦中的專業知識寫出來,並且在網路上建立影響力。
在這堂課程中主要會教你 3 大主題:
• 懂寫作觀念:說明網路寫作是什麼,把時間與力氣放對地方
• 聊寫作好處:了解為什麼要在網路上寫作,知道 Why 才能寫的久
• 學寫作技巧:學習一套寫作策略,讓你能有自信地一步步的寫出別人喜歡的專業文章
現在報名,就能享有早鳥優惠(現省 NT. 1,000)。
這堂課採小班制限額 30 位,報名額滿後就不會加收了。
報名資訊可以看下面 👇
拉回到本週內容,先快速介紹一下這篇文章的背景。
我是一位在軟體業工作的技術寫手,工作是幫忙公司寫對外的軟體產品教學文件。
這禮拜我和同事們和我在開專案會議 (Sprint Meeting) 時,團隊一起檢查下個週期要做的任務工單 (Jira Ticket)。
備註:
因軟體業公司多數都使用 Jira 這款專案管理軟體,
產業內的大家都習慣稱呼任務工單為 Jira Ticket。
這時發生一個有趣的狀況:有些工單的標題,竟然沒人看得懂!
大家開玩笑的說:
「Henry 你應該出一本, 專門教學怎麼寫 Jira Ticket 的書籍。」
回到座位上後,我就問自己:
這個主題有意思。
使用 Jira 管理專案的團隊,如何寫出一個清楚的任務工單呢?
下面我將一張任務工單拆分成兩個部分:
Part 1. 工單標題
Part 2. 工單內容
下面讓我跟你分享,如何寫出一張清楚的任務工單。
備註:這篇文章不討論 User Story 和 Definition of Done 的寫法,而是專注在任務的通用寫法上。
Part 1. 工單標題怎麼寫?
我們可以套用一個寫作公式:
動作 + 名詞 + 目的。
我們來看 6 個範例,分別是 6 種不同職位的角色會開的工單。
範例 1. 營運團隊
(X) 官網
(O) 更新官網 Landing page,以配合行銷團隊 2024.02 月行銷活動
範例 2. 前端工程師
(X) A 欄位是否可簡化
(O) 討論 A 欄位是否可簡化,讓畫面操作變簡潔
範例 3. 後端工程師
(X) 資料庫 migration
(O) 執行資料庫 migration,以支援 CRM 系統的最新功能
範例 4. 技術寫手
(X) 更新API文件
(O) 更新 API 文件,以包含此次上版最新的 Endpoint 變更和參數規格
範例 5. 測試工程師
(X) 測試新功能
(O) 執行回歸測試,以確保本次 Sprint 上線功能不會影響現有系統的穩定性
範例 6. UI/UX Designer
(X) [Login][2FA] 相關信件
(O) 設計 [Login][2FA] 相關信件,讓使用者入金後能收到通知信件
按照這個公式,稍微修正就能寫出清楚的標題。
如果你覺得:
這樣寫標題感覺會變的好冗長。
那可以將公式簡化為:
動作 + 名詞。
我們拿上面的範例來修改看看:
營運團隊: 更新官網 Landing page
前端工程師: 討論 A 欄位是否可簡化
後端工程師: 執行資料庫 migration
技術寫手: 更新 API 文件
測試工程師: 執行回歸測試
UI/UX Designer: 設計 [Login][2FA] 相關信件
看起來簡單多了。
不過採用這種寫法,一定要將這張任務工單的「目的」寫到「工單內容」中。
下面我們來看「工單內容」要怎麼寫。
Part 2. 工單內容
我自己在寫「工單內容」的時候,一定會寫下方 3 個內容:
為什麼要做
要做什麼
參考資料
內容 1. 為什麼要做 (Why)
寫下這張任務工單的任務背景。
例如有一張任務工單的標題是【在產品文件上加上 GA 追蹤,以追蹤使用者閱讀文件的成效。】
那麼在寫任務背景時,可以這樣寫:
想了解使用者「在文件上的哪一個功能」停留較久,藉此分析哪些是重點功能必須多做解釋、哪些內容可能沒幫助。
想想為什麼要做這張票,把原因寫下來。
內容 2. 要做什麼 (What)
用步驟或是條列式的方式,寫下要執行的內容。
這邊可以分成兩種狀況來處理。
在下方的例子中,我是從「技術寫手」的角度寫下這張 任務工單。
狀況 1. 自己熟悉任務步驟
如果你已經明確知道自己/別人要幹嘛,則可以一步步寫下要做的任務。
例如:
前端至 Google Analytics 建立屬性並取得追蹤 ID
將追蹤 ID 新增至技術文件中的 config 檔
用列點 (Bullet Point) 的方式,一條條寫下來。
狀況 2. 自己不熟悉任務步驟
先列下要做什麼事情,跟相關的人討論後再更新即可。
假設我對 GA 一竅不通,則可以簡單先寫:請前端協助申請 GA 追蹤碼。
跟前端討論後,再更新成需要做的任務就好。
內容 3. 參考資料 (Reference)
放上此張任務工單的參考連結。
例如:
Github 連結
Figam 設計稿
Draw.io 流程圖
Google Doc 參考文件
只要能幫助看工單的人理解,都可以放上來。
只需要這個簡單的內容框架:
為什麼要做 (Why)
要做什麼 (What)
參考資料 (Reference)
就可以寫出清楚好懂的任務工單了。
聽起來不錯但是忘記怎麼辦?來,推薦你好用的軟體小工具
如果你怕自己會忘記這個模版的話,可以用一些小工具做輔助。
上網搜尋「Text Expander」,就有許多現成的軟體小工具可以使用。Text Expander 的功能很簡單:
你輸入特定關鍵字,電腦自動帶出寫好的內容。
例如我將 :jira 設定為關鍵字,輸入後電腦會自動帶出以下內容:
為什麼要做 (Why)
要做什麼 (What)
參考資料 (Reference)
極度推薦給上班族,超級好用!
下面再加碼我用過不錯的「Text Expander」。
推薦工具 1. Espanso
價格:免費
作業系統:Mac 跟 Windows 都可以用
備註:使用起來相對困難,必須自己將模版加入 .ymal 檔案中。
推薦工具 2. Rocket Typist
價格:付費
作業系統:僅 Mac 可用
備註:使用介面做的不錯,電腦跟手機都可以用。
推薦工具 3. 自然輸入法
價格:付費
作業系統:Mac 跟 Windows 都可以用
備註:在自然輸入法 > 文字範本,可以新增模版
你的團隊也在使用 Jira 嗎,趕快來試試看這個寫作技巧吧!
你在公司中也需要寫類似「任務工單」的東西嗎?
📥 如果你也遇過同事寫的不清不處的狀況,歡迎回信跟我分享經驗