電子報撰寫工具 是做什麼的?
撰寫產品更新郵件和功能公告新聞信。處理主旨、預覽文字、郵件結構,以及符合目標受眾的內容。
輸入解析
依序解析提供的參數(若有的話):
- 現有行銷摘要檔案的路徑(
.md檔案,包含「執行摘要」或「關鍵訊息」) -> 行銷摘要 - 現有部落格文章的路徑(
.md檔案,具有部落格文章結構) -> 部落格文章 - 現有變更紀錄的路徑(
.md檔案,包含「新增/修正/變更」章節或 CHANGELOG.md) -> 變更紀錄 - 符合 GitHub URL 或
#\d+模式 -> PR - 包含
...或..-> Git 引用範圍 - 解析為現有檔案/目錄 -> 程式碼庫功能
- 其他情況 -> 自由文字
若未提供參數,則詢問:「這次的新聞信要涵蓋什麼內容?您可以提供行銷摘要、部落格文章、變更紀錄、PR 網址/編號、Git 引用範圍、檔案/目錄路徑,或直接描述這次的更新。」
若有多個解釋符合,則與使用者確認。
流程
digraph newsletter {
rankdir=TB;
"解析輸入" [shape=box];
"階段 1:探索" [shape=box];
"階段 2:配置" [shape=box];
"階段 3:撰寫" [shape=box];
"階段 4:審閱" [shape=box];
"已核准?" [shape=diamond];
"階段 5:輸出" [shape=box];
"解析輸入" -> "階段 1:探索";
"階段 1:探索" -> "階段 2:配置";
"階段 2:配置" -> "階段 3:撰寫";
"階段 3:撰寫" -> "階段 4:審閱";
"階段 4:審閱" -> "已核准?";
"已核准?" -> "階段 3:撰寫" [label="修改"];
"已核准?" -> "階段 5:輸出" [label="是"];
}
請勿跳過任何階段。 以自然節奏提問。若使用者一次回答多個問題,可一次接受所有答案並直接跳過相關問題。
若使用者說「用預設值就好」、「你決定就好」或類似內容,請根據上下文選取合理的預設值,說明您的選擇,並在使用者確認前再進行一次確認。
未經確認,切勿假設。
階段 1:探索
步驟 1 - 分析輸入
| 輸入類型 | 應讀取的內容 |
|---|---|
| 行銷摘要 | 擷取問題陳述、價值主張、目標受眾、關鍵訊息。直接跳到步驟 3。若摘要缺少產品背景,仍需執行步驟 2。 |
| 部落格文章 | 擷取標題、關鍵重點、目標受眾、行動呼籲。直接跳到步驟 3。若缺少產品背景,仍需執行步驟 2。 |
| 變更紀錄 | 擷取所有條目。作為摘要郵件的基礎。直接跳到步驟 3。 |
| PR | Diff、PR 描述、審查意見、提交訊息(使用 gh pr view、gh pr diff)。若 PR 較大(20 個以上檔案),專注於使用者可見的變更。 |
| Git 引用 | git diff 和 git log 在兩個引用之間。若是較大範圍,優先考慮提交訊息和使用者可見的變更。 |
| 程式碼庫功能 | 讀取指定的檔案/目錄。 |
| 自由文字 | 解析使用者的描述。若缺少具體細節,請使用者提供更多資訊或指向特定檔案/PR。僅在無法取得時,才回歸到開放式問題。 |
使用者可見的變更包括:新功能、UI 變更、API 變更、效能改善、錯誤修正和文件更新。內部變更包括:重構、測試新增、CI 變更和相依套件升級。若不確定,列出找到的內容並詢問使用者哪些是相關的。
錯誤處理:
gh不可用 -> 告知使用者,建議執行gh auth login,提供替代輸入方式- 無效的 PR/引用 -> 請使用者驗證
- 找不到檔案 -> 要求提供正確路徑
步驟 2 - 讀取更廣泛的產品背景
若存在則讀取:README、docs/、package.json(或同等檔案)。
若找不到任何內容,請詢問:「我在這個儲存庫中找不到產品相關背景。您可以簡短描述一下這個產品以及它的目標使用者是誰嗎?」
步驟 3 - 呈現理解並決定格式
呈現結構化摘要:
「以下是我製作新聞信的基礎:」
- 更新 A - 簡短描述
- 更新 B - 簡短描述
「需要新增、刪除或修正任何內容嗎?」
接著根據更新數量決定郵件格式:
- 單一重大更新 -> 單一功能郵件(重點深入)
- 多項更新 -> 摘要郵件(按優先級排序,最重要的詳細說明)
與使用者確認格式。
若在輸入中找不到使用者可見的變更,請告知使用者並停止:「在輸入中找不到使用者可見的變更,沒有內容可以撰寫新聞信。」
在使用者確認範圍和格式之前,請勿繼續。
階段 2:配置
提出以下問題:
Q1 - 受眾:「這封郵件要發送給誰?」(所有使用者、進階使用者、新使用者、特定方案層級、開發人員、非技術使用者、其他)
Q2 - 輸出格式:「您希望郵件以什麼格式輸出?」
- 僅文字 - 主旨、預覽文字、內文、行動呼籲文字(可直接貼入郵件工具)
- Markdown - 格式化 Markdown,大多數郵件工具可匯入
Q3 - 語氣: 讀取現有的儲存庫內容(README、docs、部落格文章)來偵測產品的語氣。然後確認:
「根據您現有的內容,語氣似乎是 [例如:對話式且對開發人員友善]。我應該沿用那種語氣,還是採用不同方向?」
若沒有現有內容可分析,直接詢問使用者想要的語氣。
Q4 - 行動呼籲: 根據上下文推斷最適合的行動呼籲:
- 新功能 -> 「立即試用」、「查看最新功能」
- 改善 -> 「立即查看」、「感受差異」
- 開源 -> 「立即更新」、「查看版本」
「我建議行動呼籲為:[推斷的行動呼籲]。您想用這個,還是其他建議?」
階段 3:撰寫
主旨
產生 3-5 個主旨選項,採用不同策略:
- 利益驅動型(「您的報表現已支援 PDF 匯出」)
- 引發好奇型(「我們重新打造了搜尋功能」)
- 特定功能名稱型(「深色模式登場」)
- 提問型(「還在等匯出完成嗎?」)
- 急迫/即時型(「本週新消息:您要求的 3 個功能」)
建議其中一個,並說明為何它最有效。同時解釋其他選項的取捨。
規則:
- 30-50 個字元為最佳長度(避免在手機上被截斷)
- 要具體,不要泛泛而談(「新增:PDF 匯出」優於「產品更新 - 2026 年 3 月」)
- 避免垃圾郵件觸發詞(免費、立即購買、馬上行動)
預覽文字
為每個主旨選項產生預覽文字。預覽文字是收件匣中主旨行下方顯示的次要文字。
規則:
- 40-130 個字元
- 擴充主旨的內容,不要重複
- 包含主要利益或成果
郵件內文
單一功能郵件結構:
- 問題陳述 - 用一句話描述此功能解決的痛點
- 變更內容 - 2-3 句話,從使用者利益的角度描述更新(「報表載入更快」而非「最佳化 SQL 查詢執行計畫」)
- 視覺佔位符 -
<!-- TODO: 加入顯示此功能操作的螢幕截圖或 GIF -->並附上應擷取內容的描述 - 行動呼籲按鈕 - 單一明確動作
摘要郵件結構:
- 主要更新 - 最重要的更新採用完整的單一功能寫法(問題、變更內容、視覺元素、行動呼籲)
- 次要更新 - 簡短條列式說明,附帶一行描述和連結
- 快速修正 / 改善 - 較小變更的分組清單
- 結尾行動呼籲 - 單一動作或「查看所有更新」
寫作規則
- 從使用者利益出發,而非強調您建構了什麼
- 採用對話式語氣,避免企業腔
- 段落簡短(每段最多 2-3 句)
- 一個段落一個概念
- 在產生的內容中絕對不要使用破折號。不要使用「---」字元。改用逗號、冒號、句號或括號。
- 避免行話。「報表載入更快」優於「最佳化 SQL 查詢執行計畫」
- 使用粗體標示關鍵片語,方便快速掃讀
- 保持易於掃讀。越短越好。如果郵件需要超過 60 秒閱讀,就太長了。
區隔版本
在產生主要郵件後,詢問:
「需要我為不同的受眾區隔產生變體嗎?(例如:為開發人員提供更技術性的版本,為非技術使用者提供更簡單的版本)」
如果需要,則產生要求的變體,並根據區隔調整語氣、深度和功能強調重點。
階段 4:審閱
呈現完整的郵件:
「以下是新聞信內容:」
主旨選項:(附帶推薦選項及每個選項的預覽文字)
- 主旨:「...」 / 預覽:「...」
- 主旨:「...」 / 預覽:「...」
- 主旨:「...」 / 預覽:「...」
內文: [完整郵件內容]
「請選擇一個主旨,並告訴我是否需要任何修改。」
等待使用者選取主旨並核准或要求修改。只有在核准後才能進入輸出階段。
階段 5:輸出
務必將最終核准的郵件列印到終端機。
接著詢問:「需要我將此內容儲存到 emails/<slug>.md 嗎?或是指定其他路徑?」
若目錄不存在則建立。若檔案已存在,詢問是否要覆寫或建立一個帶版本號的副本。
錯誤處理
gh不可用 -> 告知使用者,提供替代輸入方式- 無效的 PR/引用 -> 請使用者驗證
- 無產品背景 -> 請使用者描述產品
- 無現有郵件目錄 -> 預設為
emails/,建立該目錄
此技能「不」包含的功能
- 發送或排程郵件
- 管理訂閱者清單或區隔邏輯
- 建立郵件範本或設計系統
- 產生部落格文章或社群媒體文案(請使用
/blog-post或/social-copy)