內容指南?
為了為社區提供最好的文檔，我們在這里列出了一些指南、技巧和訣竅，讓您的內容更加出色！雖然我們鼓勵您采用自己的寫作風格，但仍有一些規則適用于使讀者更加清晰和理解。
寫作風格?
為文檔撰寫 并不同于為博客或其他媒介撰寫。讀者更可能會瀏覽以找到他們正在尋找的信息。請記住，用戶文檔是一個用于信息和描述的地方，而不是說服和推廣的地方。
一致性?
一致性是關鍵。
確保您的寫作風格保持 一致 。如果您修改現有文本，請嘗試匹配現有的語氣和表達方式，或者重寫以匹配您自己的風格。
語法時態?
在英語中，描述和指令需要使用 現在時 ，而 將來時 僅在特定事件將來發生時才合適。在其他語言中，這種邏輯可能會有所不同。
- 好的例子（現在時）：屏幕截圖會自動調整大小以適應內容塊的寬度。
- 不好的例子（未來）：當您截取屏幕截圖時，請記住它將自動調整大小以適應內容塊的寬度。
段落?
一個段落包括幾個由共同思想聯系在一起的句子。通常為兩到六行。
在英語中，一個新的想法意味著一個新的段落，而不是像其他一些語言中常見的那樣有一個 換行符 。 換行符 對于布局很有用，但不應該被用作分離思想的語法方式。
另請參閱
標題和標題?
如何編寫好的標題和標題行：
言簡意賅。
避免使用句子 ，不必要的動詞，疑問句和以“如何”開頭的標題。
不要在標題中使用代詞 ，特別是第二人稱（ 你的 ）。
使用 句首大寫 。這意味著只有首字母大寫：
標題或標題的第一個單詞
冒號后的第一個單詞
專有名詞（品牌、產品和服務名稱等）
注解
大多數標題和標題通常是指一個概念，而不是表示一個功能或模型的名稱。
如果首字母縮略詞不包含專有名詞，則不要將其單詞大寫。
標題中的動詞很好，因為它們通常描述一個動作。
Example
標題 （H1）
報價模板
鉛礦開采
從另一個倉庫補貨
將 Google 日歷與 Odoo 同步
批量支付：SEPA直接借記（SDD）
使用光學字符識別（OCR）技術數字化供應商賬單
標題 (H2，H3)
項目階段
電子郵件別名
確認報價單
生成SEPA直接借記XML文件以提交付款
文檔結構?
使用不同的 標題級別 來按照章節和子章節組織您的文本。您的標題不僅會在文檔中顯示，還會顯示在導航菜單中（僅限H1），以及在“本頁內容”側邊欄中（所有H2到H6）。
H1：頁面標題
您的 頁面標題 可以讓讀者快速清晰地了解您的內容是關于什么的。
本節中的 內容 從 商業角度 描述了即將推出的內容，不應強調Odoo，因為這是文檔而不是營銷。 首先，從一個 引導段落 開始，幫助讀者確保他們找到了正確的頁面，然后在接下來的段落中解釋這個主題的 商業方面 。 |
||
H2：部分標題（配置）
這個第一個 H2 標題是關于功能的配置，或者實現特定目標的先決條件。要添加路徑，請確保使用
:menuselection: 專用指令（參見下面的鏈接）。例子：
要這樣做，請轉到“ ”，然后啟用XYZ功能。
|
||
H2：章節標題（主要章節）
創建與您要區分的操作或功能相同數量的主要部分。標題可以以動詞開頭，但請避免使用“創建…”。
|
||
H3：子標題
子標題非常適合評估非常具體的點。如果合適，標題可以采用問題形式。
|
||
H2: 下一節 |
||
另請參閱
組織文檔?
在撰寫有關某個主題的文檔時，請嘗試將同一文件夾中的頁面組織好。
對于大多數主題，一個頁面就足夠了。將其放置在文檔的適當部分（例如，與CRM應用相關的內容放在 下），并遵循 文檔結構 指南。
對于更加復雜的主題，您可能需要多個頁面來涵蓋它們的所有方面。通常情況下，您會發現自己需要為已經部分涵蓋的主題添加文檔。在這種情況下，要么創建一個新頁面并將其放置在其他相關頁面的同一級別，要么向現有頁面添加新的章節。如果您要從頭開始記錄一個復雜的主題，請在一個父頁面（即 TOC 頁面）和多個子頁面之間組織您的內容。在可能的情況下，不僅在子頁面上編寫內容，還要在父頁面上編寫內容。使用 show-content 元數據指令，使父頁面可以從導航菜單中訪問。
圖片?
添加一些圖片來說明您的文本有助于讀者理解和記憶您的內容。但是，避免添加過多的圖片：不需要說明所有步驟和功能，這可能會使您的頁面過載。
重要
Don’t forget to 使用 pngquant 壓縮你的 PNG 文件 。
屏幕截圖?
屏幕截圖會自動調整大小以適應內容塊的寬度。這意味著屏幕截圖不能太寬，否則它們會在屏幕上顯得非常小。因此，我們建議避免截取應用程序的全屏顯示屏幕截圖，除非這樣做是相關的。
提高截圖質量的幾個技巧：
放大 瀏覽器。我們建議將縮放比例設置為110％以獲得更好的結果。
調整 瀏覽器的寬度，可以通過 調整窗口大小 或者打開 瀏覽器開發者工具 （按下
F12鍵）并調整寬度來實現。選擇 相關區域，而不是保留整個窗口。
如果必要，您可以 編輯 截圖以刪除不必要的字段，并進一步縮小Odoo的顯示范圍。
注解
調整窗口寬度是最重要的步驟，因為Odoo的響應式設計會自動調整所有字段以匹配窗口的寬度。
媒體文件?
一個 媒體文件名 ：
使用 小寫字母 編寫
與媒體內容 相關 。（例如：
screenshot-tips.gif。）使用連字符
-將單詞分隔開（例如：awesome-filename.png）。
每個文檔都有自己的文件夾，其中包含媒體文件。文件夾的名稱必須與文檔的文件名相同。
例如，文檔 doc_filename.rst 引用了兩個圖片，它們被放置在文件夾 doc_filename 中。
├── section
│ └── doc_filename
│ │ └── screenshot-tips.gif
│ │ └── awesome-filename.png
│ └── doc_filename.rst
注解
之前，圖像文件名通常以數字命名（例如， feature01.png ），并放置在一個單獨的“media”文件夾中。雖然建議不要以這種方式命名 新 圖像，但也必須 不要重命名未更改的文件 ，因為這樣做會使重命名的圖像文件在存儲庫中的大小加倍。隨著引用這些圖像的內容的更新，它們最終都將被替換。