Merge lp:~openerp-community/openobject-doc/mgmtsystem into lp:~openerp-community/openobject-doc/6.0

Status: Merged
Merged at revision: 772
Proposed branch: lp:~openerp-community/openobject-doc/mgmtsystem
Merge into: lp:~openerp-community/openobject-doc/6.0
Diff against target: 363 lines (+314/-0)
6 files modified
source/book/7/7_23_Managementsystem/7_23_Managementsystem_action.rst (+62/-0)
source/book/7/7_23_Managementsystem/7_23_Managementsystem_audit.rst (+61/-0)
source/book/7/7_23_Managementsystem/7_23_Managementsystem_manual.rst (+69/-0)
source/book/7/7_23_Managementsystem/7_23_Managementsystem_nonconformity.rst (+62/-0)
source/book/7/7_23_Managementsystem/index.rst (+59/-0)
source/book/7/index.rst (+1/-0)
To merge this branch: bzr merge lp:~openerp-community/openobject-doc/mgmtsystem
Reviewer Review Type Date Requested Status
Don Kirkby Approve
Maxime Chambreuil (http://www.savoirfairelinux.com) Approve
Els Van Vossel (Foxy) Pending
Review via email: mp+53503@code.launchpad.net

This proposal supersedes a proposal from 2011-03-15.

Description of the change

[ADD] Management system

To post a comment you must log in.
Revision history for this message
Don Kirkby (donkirkby) wrote : Posted in a previous version of this proposal

Hi Maxime,
Thanks for the contribution, I noticed a few minor problems that should be cleaned up, along with a question:
1. /mnt/workspace/don/openerp-bzr/doc2/6.0/source/book/7/7_23_Managementsystem/7_23_Managementsystem_action.rst:28: (WARNING/2) Block quote ends without a blank line; unexpected unindent.
2. /mnt/workspace/don/openerp-bzr/doc2/6.0/source/book/7/7_23_Managementsystem/7_23_Managementsystem_action.rst:30: (WARNING/2) Definition list ends without a blank line; unexpected unindent.
3. Link to mgmtsystem_environment module has a typo.
4. Why do you hide the table of contents on the index page?

yours,
Don

review: Needs Fixing
Revision history for this message
Maxime Chambreuil (http://www.savoirfairelinux.com) (max3903) wrote : Posted in a previous version of this proposal

Hi Don,

> 1. /mnt/workspace/don/openerp-bzr/doc2/6.0/source/book/7/7_23_Managementsystem
> /7_23_Managementsystem_action.rst:28: (WARNING/2) Block quote ends without a
> blank line; unexpected unindent.

Fixed.

> 2. /mnt/workspace/don/openerp-bzr/doc2/6.0/source/book/7/7_23_Managementsystem
> /7_23_Managementsystem_action.rst:30: (WARNING/2) Definition list ends without
> a blank line; unexpected unindent.

Fixed.

> 3. Link to mgmtsystem_environment module has a typo.

Fixed.

> 4. Why do you hide the table of contents on the index page?

I did the same as the Document Management chapter.

review: Needs Resubmitting
Revision history for this message
Maxime Chambreuil (http://www.savoirfairelinux.com) (max3903) : Posted in a previous version of this proposal
review: Approve
Revision history for this message
Olivier Dony (Odoo) (odo-openerp) wrote : Posted in a previous version of this proposal

Maxime, I also asked Els (~evv-openerp) to review your proposal, as she is ultimately responsible for the book content, structure, etc.
From a technical point of view, this look good to me, at revision 771.

Revision history for this message
Don Kirkby (donkirkby) wrote : Posted in a previous version of this proposal

All the other problems seem fixed, but there's a new one:

/mnt/workspace/don/openerp-bzr/doc2/6.0/source/book/7/7_23_Managementsystem/index.rst:10: (WARNING/2) Inline emphasis start-string without end-string.

review: Needs Fixing
Revision history for this message
Maxime Chambreuil (http://www.savoirfairelinux.com) (max3903) :
review: Approve
Revision history for this message
Don Kirkby (donkirkby) wrote :

OK, you no longer have any warnings. Unless anyone else has comments on the content I think you can merge it, Maxime. You know you have commit access to the target branch, right?

In my browser, the screenshots are a bit too wide for the page layout. On other pages, I've fixed that by replacing these two lines:

   :scale: 75
   :align: center

with this:

   :width: 100%

Also, your formatting of the menu selection on the nonconformity page line 15 is broken because of the line break.

These are such minor things that I think you can go ahead and commit without another review.

review: Approve

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1=== added directory 'source/book/7/7_23_Managementsystem'
2=== added file 'source/book/7/7_23_Managementsystem/7_23_Managementsystem_action.rst'
3--- source/book/7/7_23_Managementsystem/7_23_Managementsystem_action.rst 1970-01-01 00:00:00 +0000
4+++ source/book/7/7_23_Managementsystem/7_23_Managementsystem_action.rst 2011-03-15 19:21:07 +0000
5@@ -0,0 +1,62 @@
6+
7+.. index:: Actions
8+
9+Actions
10+=======
11+
12+.. index::
13+ single: actions
14+ single: module; mgmtsystem_action
15+
16+You can create actions directly from the nonconformity or from the menu
17+:menuselection:`Management System --> Management System --> Actions`.
18+
19+
20+.. figure:: images/mgmtsystem_action.png
21+ :scale: 75
22+ :align: center
23+
24+ *Immediate, corrective or preventive action*
25+
26+
27+For each action, you give it a subject, a deadline, a user responsible for carrying
28+out the action and a type:
29+
30+ * immediate action: an action that can be quickly closed (in less than a day).
31+ * corrective action: an action to solve the nonconformity.
32+ * preventive action: an action which makes sure you will not face the same
33+ nonconformity once again in the future.
34+ * improvement opportunity: an action that might be relevant for you to implement.
35+ You have to evaluate if it makes sense for your business.
36+
37+The person in charge of the action can then detail his different steps as internal
38+note or email. Once the action has proven to be completed and efficient, the action
39+is closed.
40+
41+
42+.. Copyright © Open Object Press. All rights reserved.
43+
44+.. You may take electronic copy of this publication and distribute it if you don't
45+.. change the content. You can also print a copy to be read by yourself only.
46+
47+.. We have contracts with different publishers in different countries to sell and
48+.. distribute paper or electronic based versions of this book (translated or not)
49+.. in bookstores. This helps to distribute and promote the OpenERP product. It
50+.. also helps us to create incentives to pay contributors and authors using author
51+.. rights of these sales.
52+
53+.. Due to this, grants to translate, modify or sell this book are strictly
54+.. forbidden, unless Tiny SPRL (representing Open Object Press) gives you a
55+.. written authorisation for this.
56+
57+.. Many of the designations used by manufacturers and suppliers to distinguish their
58+.. products are claimed as trademarks. Where those designations appear in this book,
59+.. and Open Object Press was aware of a trademark claim, the designations have been
60+.. printed in initial capitals.
61+
62+.. While every precaution has been taken in the preparation of this book, the publisher
63+.. and the authors assume no responsibility for errors or omissions, or for damages
64+.. resulting from the use of the information contained herein.
65+
66+.. Published by Open Object Press, Grand Rosière, Belgium
67+
68
69=== added file 'source/book/7/7_23_Managementsystem/7_23_Managementsystem_audit.rst'
70--- source/book/7/7_23_Managementsystem/7_23_Managementsystem_audit.rst 1970-01-01 00:00:00 +0000
71+++ source/book/7/7_23_Managementsystem/7_23_Managementsystem_audit.rst 2011-03-15 19:21:07 +0000
72@@ -0,0 +1,61 @@
73+
74+.. index:: Audits
75+
76+Audits
77+======
78+
79+.. index::
80+ single: audit
81+ single: module; mgmtsystem_audit
82+
83+You can then plan your audit calendar by creating audits from the menu :menuselection:`Management System --> Management System --> Audits`.
84+You give it a name, and a date and time. You can then assign the auditors and the auditees.
85+
86+
87+.. figure:: images/mgmtsystem_audit.png
88+ :scale: 75
89+ :align: center
90+
91+ *Management system audit*
92+
93+The auditor can then fill in the verification list with questions based on the manual, the procedure (or the environmental aspects) and the work instructions. He will be able to print the verification list (report) and carry out his audit.
94+
95+
96+.. figure:: images/mgmtsystem_verification.png
97+ :scale: 75
98+ :align: center
99+
100+ *Verification line*
101+
102+
103+At the end of the audit, he will add the answers to his questions in the verification list stating if it is conformed or not. He will provide feedbacks to the auditees with the strong points and points to improve. The auditor will be suggesting improvement opportunities and explaining the nonconformities he discovered.
104+
105+Once completed, the auditor can close the audit and generate his audit report.
106+
107+
108+.. Copyright © Open Object Press. All rights reserved.
109+
110+.. You may take electronic copy of this publication and distribute it if you don't
111+.. change the content. You can also print a copy to be read by yourself only.
112+
113+.. We have contracts with different publishers in different countries to sell and
114+.. distribute paper or electronic based versions of this book (translated or not)
115+.. in bookstores. This helps to distribute and promote the OpenERP product. It
116+.. also helps us to create incentives to pay contributors and authors using author
117+.. rights of these sales.
118+
119+.. Due to this, grants to translate, modify or sell this book are strictly
120+.. forbidden, unless Tiny SPRL (representing Open Object Press) gives you a
121+.. written authorisation for this.
122+
123+.. Many of the designations used by manufacturers and suppliers to distinguish their
124+.. products are claimed as trademarks. Where those designations appear in this book,
125+.. and Open Object Press was aware of a trademark claim, the designations have been
126+.. printed in initial capitals.
127+
128+.. While every precaution has been taken in the preparation of this book, the publisher
129+.. and the authors assume no responsibility for errors or omissions, or for damages
130+.. resulting from the use of the information contained herein.
131+
132+.. Published by Open Object Press, Grand Rosière, Belgium
133+
134
135=== added file 'source/book/7/7_23_Managementsystem/7_23_Managementsystem_manual.rst'
136--- source/book/7/7_23_Managementsystem/7_23_Managementsystem_manual.rst 1970-01-01 00:00:00 +0000
137+++ source/book/7/7_23_Managementsystem/7_23_Managementsystem_manual.rst 2011-03-15 19:21:07 +0000
138@@ -0,0 +1,69 @@
139+
140+.. index:: Manuals
141+
142+Manuals
143+=======
144+
145+.. index::
146+ single: manual
147+ single: module; wiki_quality_manual
148+ single: module; wiki_environment_manual
149+
150+Each management system starts with a manual reflecting the structure of the corresponding ISO standards.
151+You can fill in the blanks in the structure of the wiki page from the menu :menuselection:`Knowledge --> Collaborative Content --> Wiki pages`.
152+
153+
154+.. figure:: images/mgmtsystem_manual.png
155+ :scale: 75
156+ :align: center
157+
158+ *Quality manual*
159+
160+
161+Procedures and Environmental Aspects
162+====================================
163+
164+.. index::
165+ single: procedure
166+ single: environmental aspect
167+ single: module; wiki_procedure
168+ single: module; wiki_environmental_aspect
169+
170+Once you have created your manual, you will have to complete it with procedures or environmental aspects.
171+They are both managed through wiki pages in the same menu as the manual and the structure is already provided.
172+
173+
174+.. figure:: images/mgmtsystem_procedure.png
175+ :scale: 75
176+ :align: center
177+
178+
179+You can also detail your procedures with work instructions by creating new wiki pages.
180+
181+
182+.. Copyright © Open Object Press. All rights reserved.
183+
184+.. You may take electronic copy of this publication and distribute it if you don't
185+.. change the content. You can also print a copy to be read by yourself only.
186+
187+.. We have contracts with different publishers in different countries to sell and
188+.. distribute paper or electronic based versions of this book (translated or not)
189+.. in bookstores. This helps to distribute and promote the OpenERP product. It
190+.. also helps us to create incentives to pay contributors and authors using author
191+.. rights of these sales.
192+
193+.. Due to this, grants to translate, modify or sell this book are strictly
194+.. forbidden, unless Tiny SPRL (representing Open Object Press) gives you a
195+.. written authorisation for this.
196+
197+.. Many of the designations used by manufacturers and suppliers to distinguish their
198+.. products are claimed as trademarks. Where those designations appear in this book,
199+.. and Open Object Press was aware of a trademark claim, the designations have been
200+.. printed in initial capitals.
201+
202+.. While every precaution has been taken in the preparation of this book, the publisher
203+.. and the authors assume no responsibility for errors or omissions, or for damages
204+.. resulting from the use of the information contained herein.
205+
206+.. Published by Open Object Press, Grand Rosière, Belgium
207+
208
209=== added file 'source/book/7/7_23_Managementsystem/7_23_Managementsystem_nonconformity.rst'
210--- source/book/7/7_23_Managementsystem/7_23_Managementsystem_nonconformity.rst 1970-01-01 00:00:00 +0000
211+++ source/book/7/7_23_Managementsystem/7_23_Managementsystem_nonconformity.rst 2011-03-15 19:21:07 +0000
212@@ -0,0 +1,62 @@
213+
214+.. index:: Nonconformities
215+
216+Nonconformities
217+===============
218+
219+.. index::
220+ single: nonconformity
221+ single: module; mgmtsystem_nonconformity
222+
223+Prior to create a nonconformity, you need to create the list of origins (how you
224+discovered your nonconformities) and causes (the root causes) of your nonconformities
225+from the menu :menuselection:`Management System --> Configuration --> Nonconformities`.
226+
227+Then you can create nonconformities directly from the audit or from the menu :menuselection:
228+`Management System --> Management System --> Nonconformities`. You set the partner
229+involved by the nonconformity, an identifier to what it is related to and the employee
230+responsible for the nonconformity, with his manager.
231+
232+
233+.. figure:: images/mgmtsystem_nonconformity.png
234+ :scale: 75
235+ :align: center
236+
237+ *Nonconformity*
238+
239+
240+You then choose the origins of the nonconformity and the procedure involved. In the
241+description, you explain and detail the nonconformity with facts and evidences.
242+You choose the cause and then analyze why the nonconformity happened in order to
243+suggest immediate, corrective and preventive actions.
244+
245+Once all the actions have proven to be completed and efficient, you can close the
246+nonconformity.
247+
248+
249+.. Copyright © Open Object Press. All rights reserved.
250+
251+.. You may take electronic copy of this publication and distribute it if you don't
252+.. change the content. You can also print a copy to be read by yourself only.
253+
254+.. We have contracts with different publishers in different countries to sell and
255+.. distribute paper or electronic based versions of this book (translated or not)
256+.. in bookstores. This helps to distribute and promote the OpenERP product. It
257+.. also helps us to create incentives to pay contributors and authors using author
258+.. rights of these sales.
259+
260+.. Due to this, grants to translate, modify or sell this book are strictly
261+.. forbidden, unless Tiny SPRL (representing Open Object Press) gives you a
262+.. written authorisation for this.
263+
264+.. Many of the designations used by manufacturers and suppliers to distinguish their
265+.. products are claimed as trademarks. Where those designations appear in this book,
266+.. and Open Object Press was aware of a trademark claim, the designations have been
267+.. printed in initial capitals.
268+
269+.. While every precaution has been taken in the preparation of this book, the publisher
270+.. and the authors assume no responsibility for errors or omissions, or for damages
271+.. resulting from the use of the information contained herein.
272+
273+.. Published by Open Object Press, Grand Rosière, Belgium
274+
275
276=== added directory 'source/book/7/7_23_Managementsystem/images'
277=== added file 'source/book/7/7_23_Managementsystem/images/mgmtsystem_action.png'
278Binary files source/book/7/7_23_Managementsystem/images/mgmtsystem_action.png 1970-01-01 00:00:00 +0000 and source/book/7/7_23_Managementsystem/images/mgmtsystem_action.png 2011-03-15 19:21:07 +0000 differ
279=== added file 'source/book/7/7_23_Managementsystem/images/mgmtsystem_audit.png'
280Binary files source/book/7/7_23_Managementsystem/images/mgmtsystem_audit.png 1970-01-01 00:00:00 +0000 and source/book/7/7_23_Managementsystem/images/mgmtsystem_audit.png 2011-03-15 19:21:07 +0000 differ
281=== added file 'source/book/7/7_23_Managementsystem/images/mgmtsystem_manual.png'
282Binary files source/book/7/7_23_Managementsystem/images/mgmtsystem_manual.png 1970-01-01 00:00:00 +0000 and source/book/7/7_23_Managementsystem/images/mgmtsystem_manual.png 2011-03-15 19:21:07 +0000 differ
283=== added file 'source/book/7/7_23_Managementsystem/images/mgmtsystem_nonconformity.png'
284Binary files source/book/7/7_23_Managementsystem/images/mgmtsystem_nonconformity.png 1970-01-01 00:00:00 +0000 and source/book/7/7_23_Managementsystem/images/mgmtsystem_nonconformity.png 2011-03-15 19:21:07 +0000 differ
285=== added file 'source/book/7/7_23_Managementsystem/images/mgmtsystem_procedure.png'
286Binary files source/book/7/7_23_Managementsystem/images/mgmtsystem_procedure.png 1970-01-01 00:00:00 +0000 and source/book/7/7_23_Managementsystem/images/mgmtsystem_procedure.png 2011-03-15 19:21:07 +0000 differ
287=== added file 'source/book/7/7_23_Managementsystem/images/mgmtsystem_verification.png'
288Binary files source/book/7/7_23_Managementsystem/images/mgmtsystem_verification.png 1970-01-01 00:00:00 +0000 and source/book/7/7_23_Managementsystem/images/mgmtsystem_verification.png 2011-03-15 19:21:07 +0000 differ
289=== added file 'source/book/7/7_23_Managementsystem/index.rst'
290--- source/book/7/7_23_Managementsystem/index.rst 1970-01-01 00:00:00 +0000
291+++ source/book/7/7_23_Managementsystem/index.rst 2011-03-15 19:21:07 +0000
292@@ -0,0 +1,59 @@
293+
294+.. index::
295+ single: Management System
296+
297+*****************
298+Management System
299+*****************
300+
301+ *A management system is the framework of processes and procedures used to ensure that an
302+ organization can fulfill all tasks required to achieve its objectives.*
303+
304+The objective of management system is to provide all the required applications to manage your
305+manuals, procedures, environmental aspects, work instructions, audits, nonconformities,
306+improvement opportunities, immediate, corrective and preventive actions.
307+
308+For this chapter you should start with a fresh database that includes demo data,
309+with :mod:`mgmtsystem_quality`, or :mod:`mgmtsystem_environment` and their dependencies installed.
310+
311+.. raw:: html
312+
313+ <div class="all-toctree">
314+
315+.. toctree::
316+
317+ 7_23_Managementsystem_manual
318+ 7_23_Managementsystem_audit
319+ 7_23_Managementsystem_nonconformity
320+ 7_23_Managementsystem_action
321+
322+.. raw:: html
323+
324+ </div>
325+
326+.. Copyright © Open Object Press. All rights reserved.
327+
328+.. You may take electronic copy of this publication and distribute it if you don't
329+.. change the content. You can also print a copy to be read by yourself only.
330+
331+.. We have contracts with different publishers in different countries to sell and
332+.. distribute paper or electronic based versions of this book (translated or not)
333+.. in bookstores. This helps to distribute and promote the OpenERP product. It
334+.. also helps us to create incentives to pay contributors and authors using author
335+.. rights of these sales.
336+
337+.. Due to this, grants to translate, modify or sell this book are strictly
338+.. forbidden, unless Tiny SPRL (representing Open Object Press) gives you a
339+.. written authorisation for this.
340+
341+.. Many of the designations used by manufacturers and suppliers to distinguish their
342+.. products are claimed as trademarks. Where those designations appear in this book,
343+.. and Open Object Press was aware of a trademark claim, the designations have been
344+.. printed in initial capitals.
345+
346+.. While every precaution has been taken in the preparation of this book, the publisher
347+.. and the authors assume no responsibility for errors or omissions, or for damages
348+.. resulting from the use of the information contained herein.
349+
350+.. Published by Open Object Press, Grand Rosière, Belgium
351+
352
353=== modified file 'source/book/7/index.rst'
354--- source/book/7/index.rst 2011-02-21 20:20:37 +0000
355+++ source/book/7/index.rst 2011-03-15 19:21:07 +0000
356@@ -10,6 +10,7 @@
357
358 7_18_Process/index
359 7_19_Documents/index
360+ 7_23_Managementsystem/index
361 7_20_Caldav/index
362
363 .. Copyright © Open Object Press. All rights reserved.