← Back to branch summary

~openerp-community/openobject-doc/6.1

« back to all changes in this revision

Viewing changes to source/documentation_license.rst

  • Committer: TruongSinh Tran
  • Date: 2009-07-19 19:02:35 UTC
  • Revision ID: truongsinh@vipescoserver-20090719190235-fu3bxcrbpvwuk5h7
https://launchpad.net/bugs/401313
[FIX] build_i18n.py .. raw:: html

Show diffs side-by-side

added added

removed removed

Lines of Context:
source/documentation_license.rst
 
1
 
 
2
 
 
3
.. _doc-license-link:
 
4
 
 
5
Licence for the documentation
 
6
-----------------------------
 
7
 
 
8
Copyright © Open Object Press. All rights reserved.
 
9
 
 
10
You may take an electronic copy of this publication and distribute it if you 
 
11
don't change the content in any way. You can also print a copy to be read by 
 
12
yourself only.
 
13
 
 
14
We have contracts with different publishers in different countries to sell and
 
15
distribute paper or electronic based versions of this book (both translated and
 
16
not) in bookstores. This helps to distribute and promote the Open ERP product.
 
17
It also helps us to create incentives to pay contributors and authors using 
 
18
the authors rights for these sales.
 
19
 
 
20
Due to this, grants to translate, modify or sell this book are strictly
 
21
forbidden, unless Tiny SPRL (representing Open Object Press) gives you
 
22
written authorisation for this.
 
23
 
 
24
Many of the designations used by manufacturers and suppliers to distinguish their
 
25
products are claimed as trademarks. Where those designations appear in this book,
 
26
and Open Object Press was aware of a trademark claim, the designations have been
 
27
printed in initial capitals.
 
28
 
 
29
While every precaution has been taken in the preparation of this book, the publisher
 
30
and the authors assume no responsibility for errors or omissions, or for damages
 
31
resulting from the use of the information contained herein.
 
32
 
 
33
Published by Open Object Press, Grand Rosière, Belgium
 
34
 
 
35
 
 
36
FAQ about documentation Licence
 
37
===============================
 
38
 
 
39
Why not use a free documentation licence ?
 
40
++++++++++++++++++++++++++++++++++++++++++++
 
41
 
 
42
To achieve very high quality documentation, we are managing it as a standard
 
43
publication process, with quality reviews by an editor. We also think that
 
44
the documentation is worth being distributed in bookstores as printed editions
 
45
on paper. It gives very good worldwide visibility for the product.
 
46
 
 
47
When working with professional editors, like Eyrolles, they ask for
 
48
copyrights on the (translated) content so that they can easily invest in
 
49
mass printing and distribution of the book. To take this risk, they need 
 
50
protection on versions of the book that is not compatible with the GFPL.
 
51
 
 
52
 
 
53
Do you accept contributions from everyone to modify the book ?
 
54
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
55
 
 
56
Our goal is to accept most of the contributions and contributors. So we provide
 
57
written authorisation if you contribute significantly.
 
58
 
 
59
But we must keep control of the book content to ensure:
 
60
* Editors' rights are not infringed
 
61
* Incentives like paid authors/translators rights are not infringed
 
62
 
 
63
The errata section is public on the wiki. Everyone can contribute in this
 
64
section. Then an author can review modification proposals and apply them in
 
65
his or her own way.
 
66
 
 
67
Why is this a good approach ?
 
68
+++++++++++++++++++++++++++++
 
69
 
 
70
The documentation of OpenERP is one of our biggest priorities. We currently
 
71
have the best documentation amongst all open source ERP systems but it's not
 
72
enough and I am sure we can do much more better.
 
73
 
 
74
**Writing Good Documentation is Complex**
 
75
 
 
76
For years we have tried to develop community based documentation on a wiki where
 
77
everyone contributes. With Open ERP we have a strong community but, after years,
 
78
the community documentation still does not reach our expectations:
 
79
 
 
80
* Deprecated compared to new versions of the software,
 
81
* Original authors do not maintain what they write / contribute,
 
82
* Appears like we assembled different pieces of unrelated documentation,
 
83
* Sometimes contributions come from people that do not understand the software well enough,
 
84
* Not end-user oriented,
 
85
* Some have experience only in food industries, others services companies, others manufacturing, etc.
 
86
 
 
87
As a result we decided to review the way we will write and maintain future
 
88
documentation about Open ERP and Open Object.
 
89
 
 
90
**The Process**
 
91
 
 
92
Most of the best open source documentation has been fully written in one try
 
93
by only one or two people / authors. After that, the community improved the
 
94
content with small improvements here and there.
 
95
 
 
96
So I think we'd be better to focus our resources on some good individuals
 
97
rather than a global community. But writing a complete document (or even a
 
98
complete chapter) can take a long time (we took about 200 hours to write the
 
99
Open ERP book in french, 280 pages). So we need incentives to motivate these
 
100
contributors / authors.
 
101
 
 
102
So, we decided to manage all documentation about Open ERP like any other
 
103
book edition. We will set up an editing chain with the following actors:
 
104
 
 
105
* The editors: will work with authors to review the quality of the book and will distribute in a range of countries through webshops and real bookstores. The editor also defines author contracts and the graphics, charts and style. He will manage the collections (set of books).
 
106
* The authors: everyone can write his own chapter(s) and propose them to the editor. The editor will make a selection of chapters to publish complete books.
 
107
* Re-Readers: will re-read books before publication and work with the editor to achieve a high level of quality.
 
108
* Translators: will translate a particular book to their mother tongue based on the english version.
 
109
 
 
110
Editors will be different according to the countries/translations of the book.
 
111
For all French countries, we already contracted our preceding books with
 
112
Eyrolles. For the English version, we will create our own company edition to
 
113
keep the rights on the text so that we can publish it online for free.
 
114
 
 
115
Now, we have our incentives for authors and translators:
 
116
 
 
117
* Getting monthly revenue through author rights based on monthly sales,
 
118
* Being published in bookstores with our worldwide distribution channel.
 
119
 
 
120
Having established that, this should leverage individuals effort and promote
 
121
contributions on writing good documentation. As people will be published and
 
122
paid for their good work, this should promote new authors and translators.
 
123
 
 
124
Books are sold in bookstores in different countries and languages, which allows
 
125
us to remunerate the full edition chain through author rights. It will help us
 
126
to motivate authors and translators to write more chapters, and improve
 
127
existing ones.
 
128
 
 
129
We had to find a good middle point between selling through bookstores to
 
130
remunerate authors and publishing online to provide a free version. So, most of
 
131
our books (depending on the contract we have with the editor in the related
 
132
country), will be published online some months after their official
 
133
publication.
 
134
 
 
135
Our goal is to create many different books for different domains: technical
 
136
books, marketing management, services companies management, openerp for
 
137
accountants, ...
 
138
 
 
139
Book writing will be our main documentation process. At each new version of
 
140
OpenERP, we will release new versions of the different books. The editor will
 
141
organise this and will get revenues for this.
 
142
 
 
143
In addition to this, we use a community wiki for all others documentations that
 
144
are not directly related to the software or for documentations that are "per
 
145
module". For our main knowledge management system, we use Launchpad Answers,
 
146
where you can ask questions or reply answers.
 
147
 
 
148
 
 
149
**The Role of The Community**
 
150
 
 
151
This documentation writing and maintaining process tends to emphasize
 
152
individual efforts from authors and translators. This does not means we think
 
153
the community is less important for writing documentations. The community
 
154
remains very important for different reasons:
 
155
 
 
156
* The community provides authors and translators because everyone can request to be an author for one or several chapters, no need to write a full book.
 
157
* The editor needs readers that will review the book before his official release.
 
158
* These readers will be chosen amongst the different contributors in the community.
 
159
 
 
160
To improve the quality of books versions after versions, we will extensively
 
161
work on errata in the wiki. Community will be able to propose improvement
 
162
through the errata section.
 
163
 
 
164
Allowing everyone to contribute in errata instead of directly in the content
 
165
allows us to keep into control on the quality of our documentations.
 
166