ABCDEFGHIJKLMNOPQRSTUVWXYZ
1
GUIDELINES
2
3
Version 11version 11 if current version.
4
saas or master if the doc if for v12 doc branch
5
6
One page = one business problem
Some pages are not linked to a concept but just to help you select the right concept, exemple: How to pay supplier bills? (with links to SEPA, checks, Manual)
7
don't explain how to create/delete documents, explain business concepts (avoid: click here, click there, ...)
8
9
Talk about business concepts, not Odoo conceptSometimes a single concept (payment term) may cover several business concept, do 2 pages:
10
Cash discounts on customer invoices
11
Defining and using payment terms
12
13
Readable screenshots, on Odoo Enterprise onlymax 1000px width, don't scale down, reduce your window before taking screenshot
14
15
Talk "business need", not "how to use"Bad title: How to create checks?
16
Good title: How to pay supplier bills by checks?
17
18
Use the 1st person in titles, the 2nd in the texttitles should be like "How to import my address book"
19
20
Pages can include:
links to demo.odoo.com, going to the right menu and demo data directly. When you explain a concept, the user can click and test directly in demo.
21
a note to have automatically help data from fields of a specific model (don't re-explain all fields, they will be loaded automatically - the developer will add the code to do that at the place in the document you asked)
22
Tips and notes (insert a clear comment or subtitle so that they can be styled correctly in the final RST documentation)
23
24
Writing process of new topicsTo ease collaboration for new topics, we write documents in Google Docs, and port to RST once reviewed
25
If you create Google Docs, set your document share settings as "Anyone with the link - Can edit"
26
27
Update existing topicscan be done in RST on github, submit PR
28
Max 80 char per line
29
Optimize pictures (on Ubuntu: http://optipng.sourceforge.net/)
30
31
Sample Page (duplicate this page structure for a new doc page)https://docs.google.com/document/d/1GtwnVF9zo6NT7NqMwwWq85C96fGuY8SScXW8Ok4hq5M/edit?usp=sharing
32
33
Github repository for sourceshttps://github.com/odoo/documentation-user
34
Once a page is pushed to github, remove the link from the Google Docs and replace with a link to the actual online documentation
35
(===BASE(=W61)
36
37
38
39
40
41
42
43
44
45
(sssssse3eweswwes==============
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100