Agent 回覆的寫作規範
**ste-zh 用於整理 Agent 寫給使用者的結果。**規則要求一詞一義、一句一事,並將工作是否完成與是否驗證分開標示。它依靠 Agent 遵守上下文中的指令生效,沒有程式強制執行。
ASD-STE100 是簡化技術英語(Simplified Technical English)的技術文件標準。依 README 說明,該標準針對英文;ste-zh 自訂中文規則及編號,未包含標準原文或詞典,且與 ASD、STE 維護組沒有關聯。
適用內容
| 內容 | 規範 |
|---|---|
| 任務結果、進度與排查結論 | 依 ste-zh 的回覆模板撰寫。 |
| 請使用者決定或確認的問題 | 列出編號選項,說明動作及後果。 |
| 多項工作、任務卡與 issue 總結 | 分列共同條件、問題、要做與待確認事項。 |
| 程式碼、註解、commit message 與專案檔案 | 依專案規範撰寫。 |
| 原樣引用的日誌、錯誤與命令輸出 | 保留原文,不改寫字面內容。 |
來源:README.md; SKILL.md 的適用範圍。
啟用 ste
載入術語
選擇模板
結論先行
附上證據
標示驗證
回覆自檢
Claude Code 全域安裝
將整個儲存庫放入 Agent 的 skill 目錄。安裝目錄必須命名為 ste;儲存庫名稱 ste-zh 與安裝目錄名稱不同。
在終端機執行 README 提供的 Claude Code 全域安裝命令:
git clone https://github.com/dualface/ste-zh.git ~/.claude/skills/ste會話啟用與停止
在 Agent 對話中輸入 /ste。生效時,Agent 必須讀取 references/terminology.md 第 2–5 節。
/ste| 用途 | 輸入與結果 |
|---|---|
| 啟用 | /ste;README 另列出「用 STE 規範輸出」與「按 ASD-STE100 匯報」兩種觸發語句,此處已轉為繁體。 |
| 確認啟用 | 第一條回覆用一句話說明後續輸出按 ASD-STE100 原則撰寫。 |
| 維持 | 本會話中每條回覆持續遵守規則,直到使用者停止。 |
| 停止 | 輸入「停止 ste」或 stop ste,恢復預設寫法。 |
| 重新載入 | 長會話或上下文壓縮後失去規則時,再輸入 /ste。 |
寫作規則與回覆模板
SKILL.md 定義 25 條規則與 5 種模板。以下卡片是回覆格式,沒有各自的斜線指令;啟用入口仍為 /ste。
模板 · 01
進度說明
一句話的當前動作
用一句話說明正在做的事,不加入過程敘述。
模板 · 02
結果匯報
結論與驗證狀態
先寫結果,再分列改動、驗證、未做與待確認事項。
模板 · 03
排查結論
原因與定位證據
先寫原因或原因未確認,再列現象、原因、證據與建議。
模板 · 04
請求決定
編號選項
說明由使用者決定的事。每個選項列動作與後果,推薦選項放第一。
模板 · 05
多項總結
多項工作的分組格式
先定義術語與共同條件,再逐項列問題、要做與待確認事項。
25 條規則對照
下表保留上游 R1–R25 編號,將規則摘要轉為繁體。這些編號由本 skill 自訂。
| 編號 | 規則 | 檢查方式 |
|---|---|---|
| R1 | 一詞一義 | 同一意思在全文使用同一詞。 |
| R2 | 先定義,後使用 | 專用詞在術語節定義;僅一兩個時可在首次出現處定義。 |
| R3 | 具體動詞 | 直接寫「修改設定」,不將動作包裝成名詞。 |
| R4 | 字面量原樣保留 | 介面文案、命令、路徑與識別符保持原文。 |
| R5 | 名詞串上限 | 連續名詞不超過 3 個。 |
| R6 | 一句一事 | 每句只含一個動作或事實。 |
| R7 | 句長上限 | 中文步驟句不超過 30 字,描述句不超過 40 字。漢字各計 1 字;英文單字、數字或程式碼識別符各計 1 字,標點不計。 |
| R8 | 主動語態 | 寫出動作執行者;執行者不明或不重要時才用被動句。 |
| R9 | 條件在前 | 先寫條件,再寫動作。 |
| R10 | 不用雙重否定 | 直接寫出要求。 |
| R11 | 固定情態詞 | 要求、禁止與允許使用「必須」「不得」「可以」。 |
| R12 | 明確主詞 | 省略主詞會有歧義時,補出主詞。 |
| R13 | 一段一主題 | 每段不超過 6 句。 |
| R14 | 編號步驟 | 步驟使用祈使句,每步一個動作,結果另寫一句。 |
| R15 | 列表代替長句 | 3 個以上並列項使用列表。 |
| R16 | 警告先寫命令 | 先寫必須做或不得做的事,再寫不遵守的後果。 |
| R17 | 完整列舉 | 列出完整清單或其位置,不用「等」「之類」結尾。 |
| R18 | 結論先行 | 回覆第一句寫結果。 |
| R19 | 固定狀態詞 | 工作狀態僅使用術語表定義的 10 個詞。 |
| R20 | 如實標示驗證 | 每個結論附驗證狀態與方法;失敗檢查附失敗輸出。 |
| R21 | 不敘述過程 | 保留結果與必要證據,刪除執行順序敘事。 |
| R22 | 可定位證據 | 引用程式碼附路徑與行號;引用提交附 SHA;命令寫完整。 |
| R23 | 編號選項 | 推薦選項放第一並標註「推薦」,各項附動作與後果。 |
| R24 | 標明未確認 | 未核實事實寫「未確認」與確認方法。 |
| R25 | 來源中的事實 | 不補入來源沒有的內容;缺少內容列為待確認。 |
模板選擇
| 情境 | 格式 |
|---|---|
| 尚在執行工作 | 進度說明。 |
| 回報改動與檢查 | 結果匯報;有排查內容時,合併原因與證據。 |
| 解釋錯誤原因 | 排查結論;未核實時標明原因未確認。 |
| 由使用者選擇下一步 | 請求決定;一個待確認事項下列編號選項。 |
| 整理多張任務卡或多項變更 | 多項總結;保留來源的標題、規模與類型。 |
術語、狀態與證據
以下原則來自官方規則與術語表。依固定詞義檢查回覆,並將缺少的事實列入待確認。
原則 · 啟用時的術語載入
Agent 生效時必須讀取術語表第 2–5 節。表中沒有的專用詞,在回覆的術語節固定寫法。
來源 · SKILL.md 生效與持續;terminology.md 開頭
原則 · 三個情態詞
「必須」表示強制要求;「不得」表示禁止;「可以」表示允許。術語表僅限制情態用法,表示依賴的「需要」與固定欄名「要做」不受此限。
來源 · terminology.md 第 2 節
原則 · 動作與驗證的區別
「已完成」表示動作完成且結果符合要求。「已驗證」表示已執行檢查且通過,必須附檢查方法;未檢查時標明「未驗證」。
來源 · terminology.md 第 4 節
原則 · 可定位的來源
程式碼證據附檔案路徑與行號。命令寫完整,提交寫 SHA;沒有核實的事實附確認方法。
來源 · SKILL.md R22、R24
原則 · 直接動詞與固定欄名
使用「修改設定」描述動作。依模板保留「改動」「驗證」「待確認」欄名;沒有內容的節刪除。
來源 · SKILL.md R3、輸出模板;terminology.md 第 3、5 節
原則 · 多項總結的來源邊界
「問題」記錄現狀,「要做」記錄可檢查的結果。來源沒有列出的次數、行為或清單,列為待確認。
來源 · SKILL.md 多項總結;examples/task-summary.md
10 個狀態詞
| 狀態 | 定義與附帶資訊 |
|---|---|
| 已完成 | 動作全部執行,結果符合要求;此詞不單獨代表已驗證。 |
| 部分完成 | 僅執行一部分,列出尚未執行的部分。 |
| 未開始 | 尚未執行任何動作。 |
| 進行中 | 動作已開始,尚未結束。 |
| 已驗證 | 已執行檢查且通過,附檢查方法。 |
| 未驗證 | 沒有執行檢查,附原因。 |
| 失敗 | 動作或檢查不符合要求,附失敗輸出。 |
| 跳過 | 有意不執行,附原因。 |
| 阻塞 | 缺少條件而無法繼續,附缺少的條件。 |
| 未確認 | 事實尚未核實,附核實方法。 |
登入修復的結果匯報
以下是依 examples/result-report.md 整理的示意對話。**上游將案例來源標為虛構;本手冊未實際執行登入修復或測試。**檔案路徑、行號與測試數字均取自案例的「Agent 掌握的事實」。
案例要求修復登入後偶發退出。Agent 同時刪除原範圍外的重複日誌,因此回覆必須揭露該改動,並列出保留或撤回的選項。
$ 使用者 › /ste
claude: Agent ›
後續輸出按 ASD-STE100 原則撰寫。
$ 使用者 ›
請依官方結果匯報案例,整理已知事實。
claude: Agent ›
hl: 已完成:修復登入後偶發退出的問題。iOS 端未驗證。
原因
兩個請求同時刷新 token。
後完成的刷新使先拿到的 token 失效。
證據
auth/refresh.ts:42:刷新前未檢查是否已有刷新在進行。
改動
auth/refresh.ts:同一時間只發一個刷新請求。
其他請求等待這次刷新的結果。
auth/logger.ts:刪除 3 處重複日誌。
這項改動不在原範圍內。
驗證
ok: 已驗證:npm test auth;48 項通過,0 項失敗。
ok: 已驗證:auth/refresh.test.ts:88 的新增並行刷新測試通過。
未驗證:iOS 端;本機沒有 iOS 建置環境。
待確認
是否保留 auth/logger.ts 的改動:
1. 撤回(推薦);本次提交只含登入修復。
2. 保留;日誌清理與登入修復一起提交。
$ 使用者 › stop ste
回覆驗收項目
| 項目 | 範例中的證據 |
|---|---|
| 首句結論 | 登入問題的完成狀態與 iOS 未驗證狀態。 |
| 原因定位 | auth/refresh.ts:42 的刷新前檢查缺口。 |
| 驗證來源 | npm test auth 與 auth/refresh.test.ts:88 均在上游已知事實清單中。 |
| 範圍揭露 | 日誌刪除屬原範圍外改動,另列使用者決定。 |
| 缺少證據 | 沒有 iOS 建置環境,因此保留未驗證狀態。 |
實際匯報時,將範例內容替換為該次任務的事實與工具輸出。沒有執行測試時,使用「未驗證」並附原因,不沿用案例的通過數字。
生效限制與來源邊界
常駐載入與回覆自檢
依 README 的常駐載入方式設定會話,再用 SKILL.md 的自檢清單逐條檢查回覆。
設定與驗收順序
**核對啟用範圍。**輸入
/ste,確認 Agent 說明後續回覆採用規則;輸入stop ste可停止。**設定每次會話載入。**依 README,在全域規則中要求每個會話開始時載入 ste skill。Claude Code 的位置為
~/.claude/CLAUDE.md,或~/.claude/rules/下的規則檔案。**核對固定術語。**讀取術語表第 2–5 節,檢查情態詞、狀態詞與模板欄名。
**比對官方範例。**使用結果匯報與多項總結的前後對照,檢查是否增加來源沒有的事實。
**執行回覆自檢。**發出前核對首句結論、驗證狀態與證據。長會話或壓縮後規則失效時,重新輸入
/ste。
官方檔案閱讀順序
| 檔案 | 閱讀目的 |
|---|---|
| SKILL.md | 生效範圍、25 條規則、5 種模板與自檢清單。 |
| references/terminology.md | 固定譯法、情態詞、狀態詞與模板欄名。 |
| examples/result-report.md | 結果、原因、證據與範圍外改動的合併匯報。 |
多項總結範例
examples/task-summary.md 示範如何整理 3 張虛構任務卡。範例保留原標題、規模與類型,將來源未列出的機型清單、重試失敗行為及提示內容列入待確認。