内容指南¶
While we encourage you to adopt your own writing style, some rules still apply to maintain clarity and ensure readers can easily understand the content.
重要
We strongly recommend to read the RST guidelines and cheat sheet and the main 文档 pages before contributing.
Documentation organization¶
When writing documentation about a given topic, keep pages within the same folder organized.
For most topics, a single page should do the job. Place it in the appropriate section of the documentation (e.g., content related to the CRM app goes under ) and follow the document structure guidelines.
For more complex topics, several pages may be needed to cover all their aspects. Usually, you will find yourself adding documentation to a topic that is already partially covered. In that case, either create a new page and place it at the same level as other related pages or add new sections to an existing page. When documenting a complex topic from scratch, organize the content across several child pages that are referenced on that directory’s parent page (the TOC page); whenever possible, write content on the parent page and not only on the child pages. Make the parent page accessible from the navigation menu by using the show-content metadata directive.
注解
Avoid duplicating content whenever possible; if a topic is already documented on another page, reference that existing information instead of repeating it.
重要
When deleting or moving a .rst file, update the corresponding text file in the
redirects folder based on your branch’s version (e.g., 17.0.txt). To do so, add a
new line at the bottom of the relevant section (e.g., # applications/sales). On this line,
first, add the redirection entry point with the old file location, followed by a space, and then
add the exit point with the new or relevant file location. For example, if moving the file
unsplash.rst from applications/websites/website/configuration to
applications/general/integrations, add the following entry under the section
# applications/websites:
applications/websites/website/configuration/unsplash.rst applications/general/integrations/unsplash.rst
文档结构¶
Use different heading levels to organize text by sections and sub-sections. Headings are not only displayed in the document but also on the navigation menu (only the H1) and on the “On this page” sidebar (all H2 to H6).
H1: 页面标题
The page title gives readers a quick and clear understanding of what the content
is about.
The content in this section describes the upcoming content from a business point of view, and should not put the emphasis on Odoo, as this is documentation and not marketing. Under the page title (H1), start with a lead paragraph, which helps the reader make sure that they’ve found the right page, then explain the business aspects of this topic in the following paragraphs. |
||
H2：章节标题（配置）
This first H2 section is about the configuration of the feature, or the
prerequisites to achieve a specific goal.
|
||
H2：章节标题（主要章节）
Create as many main sections as you have actions or features to distinguish.
|
||
H3: 子标题
Subsections are perfect for assessing very specific points.
|
||
H2：下一节 |
||
如何编写好的标题和标题行：
Be concise: avoid sentences, questions, and titles starting with “how to”.
Do not use pronouns in your titles, especially 2nd person (you/your).
使用 句首大写。这意味着你只大写：
the first word of the title or heading;
the first word after a colon;
proper nouns (brands, product and service names, etc.).
注解
大多数标题和标题通常是指一个概念，并且 不 代表一个功能或模型的名称。
Do not capitalize the words of an acronym if they do not entail a proper noun.
标题中的动词很好，因为它们通常描述一个动作。
写作风格¶
Writing for documentation is not the same as writing for a blog or another medium. Readers are more likely to skim through content to find the information they need. Keep in mind that the documentation is a place to inform and describe, not to convince and promote.
小技巧
Avoid using you as much as possible by opting for the imperative mood where appropriate. However, do not complicate sentences just to avoid addressing the reader directly.
Example
Spelling¶
Use American English spelling and grammar throughout the documentation.
一致性¶
一切都取决于一致性。
Make sure that the writing style remains consistent. When modifying existing content, try to match the existing tone and presentation or rewrite it to match your own style.
Capitalization¶
Use sentence case in titles.
Capitalize app names, e.g., Odoo Sales, the Sales app, etc.
Capitalize labels (such as fields and buttons) as they appear in Odoo. If a label is in all caps, convert it to sentence case.
Capitalize the first letter after a colon if it is a complete sentence.
Avoid capitalizing common nouns, such as “sales order” and “bill of materials”, unless you reference a label or a model.
语法时态¶
In English, descriptions and instructions usually require the use of the present tense, while the future tense is appropriate only when a specific event is to happen ulteriorly.
Example
列表¶
Lists help organize information in a clear and concise manner and improve readability. They are used to highlight important details, guide the reader through steps in a systematic way, etc.
Use numbered lists when the sequence matters, e.g., instructions, procedures, or steps that must be performed in a particular order.
Use bulleted lists when the sequence of items does not matter, e.g., lists of features, fields, options, etc.
小技巧
Use inline text for explanations or when there are three or fewer list items.
Combine bulleted and numbered lists using nested lists where appropriate.
Consider grouping simple steps within the same list item, e.g.: Go to and click New.
Only use a period at the end of the list item if it forms a complete sentence.
Example
Bulleted list
The following fields are available on the Replenishment report:
Product: the product that requires a replenishment
Location: the specific location where the product is stored
Warehouse: the warehouse where the product is stored
On Hand: the amount of product currently available
Numbered list
To create a new website page, proceed as follows:
Either open the Website app, click + New in the top-right corner, then select Page;
Or go to and click New.
Enter a Page Title; this title is used in the menu and the page’s URL.
Click Create.
Customize the page’s content and appearance using the website builder, then click Save.
图标¶
Use icons in instructions to help readers identify user interface elements and reduce the need for lengthy explanations. Accompany every icon with a descriptor in brackets.
Example
Once the developer mode is activated, the developer tools can be accessed by clicking the (bug) icon.
图片¶
Adding a few images to illustrate text helps the readers understand and memorize the content. However, images should never replace text: written instructions should be complete and clear on their own, without relying on visual aids. Use images sparingly, for example, to highlight a particular point or clarify an example.
重要
Do not forget to compress your PNG files with pngquant.
屏幕截图¶
Screenshots are automatically resized to fit the content block’s width. This implies that if they are too wide, they are not readable on lower-resolution screens. We recommend avoiding full-screen screenshots of the app unless absolutely necessary and making sure images are no wider than a range of 768-933 pixels.
Here are a few tips to improve your screenshots:
Resize your browser’s width, either by resizing the window itself or by opening the browser’s developer tools and resizing the width.
Select the relevant area rather than keeping the entire window.
Remove unnecessary information and resize columns when applicable.
重要
Do not use markups such as rectangles or arrows on screenshots. Instead, crop the image to highlight the most relevant information, and ensure that text instructions are clear and self-explanatory without relying on images.
Example
Good example (resized browser, no unnecessary columns, adjusted columns’ width, cropped):
Bad example (full-width screenshot):
媒体文件¶
一个 媒体文件名：
is written in lower-case letters;
is relevant to the media’s content. (e.g.,
screenshot-tips.gif);separates its words with a hyphen
-(e.g.,awesome-filename.png).
Each RST file has its own folder for storing media files. The folder’s name must be the same as the RST file’s name.
例如，文档 doc_filename.rst 引用了两个放置在文件夹 doc_filename 中的图片。
├── section
│ └── doc_filename
│ │ └── screenshot-tips.gif
│ │ └── awesome-filename.png
│ └── doc_filename.rst
注解
Previously, image filenames would mostly be named with numbers (e.g., feature01.png) and
placed in a single media folder. While it is advised not to name your new images in
that fashion, it is also essential not to rename unchanged files, as doing this would double
the weight of renamed image files on the repository. They will eventually all be replaced as the
content referencing those images is updated.
ALT 标签¶
An ALT tag is a text alternative to an image. This text is displayed if the browser fails to render the image. It is also helpful for users who are visually impaired. Finally, it helps search engines, such as Google, to understand what the image is about and index it correctly, which improves SEO.
良好的ALT标签应该是：
Short (one line maximum);
Not a repetition of a previous sentence or title;
A good description of the action happening in the image;
Easily understandable if read aloud.
Example
An appropriate ALT tag for the following screenshot would be Activating the developer mode in the Settings app.
