寫作清單
目錄
使用此清單以清晰、有用且與 Docker 文件其餘部分一致的方式進行溝通。
使用主動語態
主動語態具體明確，消除了歧義。
在主動語態中，句子的主語（客戶或系統）執行動作。
使用主動語態的句子更容易閱讀。主動語態清晰地表明誰做了什麼以及對誰做了。此外，主動語態使句子直接且更簡潔。
“是”、“曾是”或“將是”等助動詞可能表示您正在使用被動語態。而且，如果您可以在動詞後面新增短語“by zombies”，則您正在使用被動語態。
| 正確 | 不正確 |
|---|---|
| 使用 Docker Desktop 提高生產力。 | 使用 Docker Desktop 可以提高生產力（透過殭屍）。 |
| 如果從網格中刪除專案，圖表會自動重新整理以顯示更改。 | 如果（被殭屍）從網格中刪除專案，圖表會自動重新整理以顯示更改。 |
撰寫直達要點的清晰句子
撰寫簡短、簡潔的句子。簡明扼要的句子閱讀速度更快，理解起來也更容易。
使用副標題和專案符號列表來劃分頁面
這有助於使用者快速輕鬆地找到所需資訊。
頁面標題以動詞開頭
例如，“安裝 Docker Desktop”。
檢查 docs.docker.com 左側目錄標題是否與頁面上顯示的標題匹配
檢查是否有失效連結和影像
使用相對連結連結到 GitHub 倉庫中的其他頁面或影像。
檢查您可能新增的任何重定向是否有效
有關如何新增重定向的資訊，請參閱原始檔約定。