撰寫檢查清單
目錄
使用本檢查清單，以清晰、實用且與其他 Docker 文件一致的方式進行溝通。
使用主動語態
主動語態更具體，並消除了歧義。
在主動語態中，句子的主詞（客戶或系統）執行動作。
使用主動語態的句子更容易閱讀。主動語態清楚地表明了誰對誰做了什麼。此外，主動語態使句子更直接、更簡潔。
諸如「是」、「被」或「將」之類的助動詞可能表示您正在使用被動語態。而且，如果您可以在動詞後面加上「被殭屍」的片語，那麼您就是在用被動語態寫作。
| 正確 | 錯誤 |
|---|---|
| 使用 Docker Desktop 提高生產力。 | 生產力可以（被殭屍）透過 Docker Desktop 提高。 |
| 如果您從網格中移除項目，圖表將自動重新整理以顯示變更。 | 如果（被殭屍）從網格中移除項目，圖表將自動重新整理以顯示變更。 |
撰寫清晰的句子，直截了當
撰寫簡短、簡潔的句子。簡潔有力的句子閱讀速度更快，也更容易理解。
使用副標題和項目符號清單來分解頁面
這有助於讀者快速輕鬆地找到他們需要的資訊。
頁面標題以動詞開頭
例如「安裝 Docker Desktop」。
檢查 docs.docker.com 中左側目錄的標題是否與頁面上顯示的標題相符
檢查是否有損壞的連結和圖片
使用相對連結來連結到 GitHub 儲存庫中的其他頁面或圖片。
檢查您可能新增的任何重新導向是否有效
有關如何新增重新導向的資訊，請參閱原始檔案慣例。