寫作清單
目錄
使用此清單來以清晰、有幫助且與 Docker 文件其餘部分一致的方式進行溝通。
使用主動語態
主動語態具體且消除了歧義。
在主動語態中,句子主語(客戶或系統)執行動作。
使用主動語態的句子更容易閱讀。主動語態清楚地表明瞭誰做了什麼以及對誰做了。此外,主動語態使句子更直接、更簡潔。
be動詞(如 is, was, would)可能表明你正在使用被動語態。而且,如果你能在動詞後加上“被殭屍”這個短語,那麼你正在使用被動語態。
正確 | 不正確 |
---|---|
使用 Docker Desktop 提高工作效率。 | 使用 Docker Desktop 可以提高工作效率(被殭屍)。 |
如果你從網格中刪除專案,圖表會自動重新整理以顯示更改。 | 如果專案從網格中被刪除(被殭屍),圖表會自動重新整理以顯示更改。 |
編寫清晰且切中要害的句子
寫簡短、簡潔的句子。有力度的句子閱讀起來更快,更容易理解。
使用副標題和專案符號列表來分隔頁面
這有助於快速輕鬆地找到所需資訊。
頁面標題以動詞開頭
例如,“安裝 Docker Desktop”。
檢查 docs.docker.com 中左側目錄的標題是否與頁面上顯示的標題一致
檢查是否存在斷開的連結和圖片
使用相對連結連結到 GitHub 倉庫中的其他頁面或圖片。
檢查你可能新增的任何重定向是否有效
有關如何新增重定向的資訊,請參閱原始檔約定。