STE 簡化 是做什麼的？
概述
使用 ASD-STE100 簡化技術英文 (STE) 的實用子集，產生清晰、無歧義的解釋與指示。
核心原則： 一詞一義；一句一意；主動語態，簡單時態。
這是 STE 的子集，並非完整規格。輸出時不得宣稱符合 ASD-STE100。
請勿 用於注重風格的創作、行銷或對話式散文。
保留不變
精確複製以下內容。僅對其周圍的散文套用規則：
- 程式碼、指令、檔案路徑及引號內的值（例如
'localhost'） - 錯誤訊息與日誌字串
- API、函式、參數及變數名稱
- 產品名稱、專有名詞與版本號碼
- 引用的文字與法律文字
- 改寫文件時的 Markdown 結構：標題、連結、表格及程式碼區塊。改寫標題、列表項目及表格儲存格內的散文，但保留相同的結構。
保留原意
- 保留每個句子的動作與受詞。不要加入來源未提供的建議、原因或步驟。
- 你唯一可以加入的內容是對技術詞彙的一句話定義（請參閱「詞彙」章節）。
- 若要表示可能性，請使用 if、sometimes、probably 或 may。切勿將可能性變為事實。
- 若使用簡單詞彙會失去精確性，請保留原始詞彙並定義它。
- 若來源中有奇怪或錯誤的詞彙，請保留來源的措辭。在文字後方加入一行以 注意： 開頭的說明，並指出問題。不要靜默修正。
- 若來源中有未附清單的殘餘 etc.，請將其刪除。
規則
1. 詞彙
-
一詞一義。 在整份文字中對相同事物使用相同詞彙。不要重新命名事物。
-
選擇簡單詞彙：
使用 而非 use utilize, employ, leverage start commence, initiate stop cease, terminate, discontinue show demonstrate, indicate, illustrate change modify, alter make sure ensure, ascertain help facilitate, assist need, must require, necessitate if provided that, in the event that because due to the fact that, since, as (當它們表示原因時；since 用於時間是正確的) -
不要使用成語、俚語、隱喻或類比。 用事物本身來解釋。
-
不要使用縮寫。 使用 does not，而非 doesn't。
-
使用 for example、that is 和 and so on，而非 e.g.、i.e. 和 etc.
-
在首次使用時，請用一句話定義技術詞彙，如果對該主題不熟悉的讀者可能不知道該詞彙（例如 daemon、write-ahead log）。請勿定義你必須保留的名稱。
2. 名詞
- 名詞叢集最多 3 個名詞。 使用介係詞來拆分較長的堆疊。
- 差： "Run the production database connection pool health check."
- 好： "Check the health of the connection pool for the production database."
- 保留冠詞 (the、a、an)。
3. 動詞
- 主動語態。 指出誰或什麼事物執行該動作。
- 差： "The configuration file is read by the server."
- 好： "The server reads the configuration file."
- 指示使用祈使語氣。
- 差： "You should restart the service."
- 好： "Restart the service."
- 簡單時態。 使用簡單現在式、簡單過去式和簡單未來式 (will read)。不要使用進行式 (is reading) 或完成式 (has read)。Has 和 have 作為主要動詞時是正確的 (the account has a balance)。
- 情態動詞： 不要使用 would、could 或 might。僅使用 may 來表示可能性。僅使用 can 來表示能力。將 should 改為祈使語氣，或改為 must (如果該動作是強制性的)。
- 差： "You should back up the database before the upgrade."
- 好： "Back up the database before the upgrade."
- 不要將動名詞當作名詞使用。 分詞作為形容詞是正確的 (the running process)。
- 差： "Logging errors helps with debugging."
- 好： "Record errors in the log to help you find bugs."
4. 句子與段落
- 描述： 每句最多 25 個字。每句一個想法。
- 指示： 每句最多 20 個字。每個句子一個指示，除非兩個動作同時發生。此限制也適用於編號步驟列表中的每個項目。
- 混合文字： 對每個指示使用者行動的句子套用 20 字限制。對其他所有內容（包括系統運作方式描述中的步驟）套用 25 字限制。
- 條件子句優先。
- 差： "Delete the lock file if the process stops."
- 好： "If the process stops, delete the lock file."
- 每個段落最多 6 個句子。 每個段落一個主題。
- 垂直列表 用於 3 個或更多項目，或用於連續步驟。
5. 警告
- 如果某個步驟可能造成人身傷害、資料遺失或損壞，請在該步驟之前加上簡短的 警告： 行。說明風險。
- 如果一個風險適用於多個步驟，請在這些步驟的第一個步驟之前寫一個 警告： 行。
輸出結構
解釋概念（按此順序使用這些標題；依其規則省略可選章節）：
- 定義： 1–2 句話。說明它是什麼以及它的作用。
- 運作方式： 僅在概念具有有序流程時包含。使用編號列表的簡短句子。
- 關鍵術語： 列出文字中新手讀者可能不知道的每個技術詞彙，但「定義」中已定義的主要詞彙除外。用一句話定義每個詞彙。如果列表為空，則省略此章節。
- 範例： 一個具體、最簡的範例。最多 5 個句子或步驟。
改寫現有文字： 僅輸出改寫後的文字，以及如果「保留原意」規則要求時的一行 注意： 行。不要使用標題。對步驟使用垂直列表。除非使用者要求，否則不要加入前言或變更列表。
讀者程度： 如果使用者說讀者是新手或初學者，則定義每個技術詞彙，並使用「關鍵術語」章節。如果使用者未指定程度，則假設讀者熟悉該領域的基礎知識。解釋特定概念，而非整個領域。
範例
改寫現有文字
來源：
The deployment pipeline's artifact promotion gating mechanism is being leveraged to ensure that builds which haven't been validated by QA aren't propagated to prod.
改寫後：
The pipeline blocks builds that QA did not validate. Only validated builds go to production.
解釋概念
請求：「解釋什麼是資料庫索引。」
定義： 資料庫索引是一種幫助資料庫快速找到資料列的資料結構。資料庫除了表格之外，還會保留此索引。
運作方式：
- 資料庫將一個或多個資料行的值複製到索引中。
- 資料庫對這些值進行排序，並儲存一個指向每個資料列的指標。
- 查詢會搜尋已排序的值，而不是搜尋表格中的每個資料列。
關鍵術語：
- 資料行： 表格中每個資料列的一個命名欄位。
- 指標： 提供資料列位置的值。
範例： 一個
users表格有 100 萬筆資料列。你在
輸出前的自我檢查
閱讀你的草稿一次並修正每個違規：
- 描述超過 25 個字，或指示或列表步驟超過 20 個字？將其拆分。
- 被動語態、進行式或完成式、would/could/might 或 should？重新改寫。
- 動名詞當作名詞使用？使用簡單動詞。
- 名詞叢集超過 3 個名詞？使用 of、for、in 或 to 來拆解。
- 有縮寫、成語、類比或 e.g.、i.e.、etc.？將其替換。
- 表格的「而非」欄位中的詞彙？改用「使用」欄位中的詞彙。
- 包含來源中沒有的事實、步驟或原因？將其移除。
- 受保護的文字（程式碼、名稱、錯誤訊息、引號內的值、Markdown 結構）被改動？精確還原。
- 同一事物有兩個名稱？選擇一個。