Sak wrote:
Krishna Aradhi wrote:
- Can reviewers add whole sections to the document under review if
they feel
that the author of the document has missed out on explaining some
feature?
Or should the review merely insert a note into the document explaining
what can be added to the document?
I'd say yes. There are a few areas of the manuals that haven't seen
revision in some time, and so you're likely to encounter chapters that
need an almost complete rewrite. I've rewritten entire sections in
chapters, particularly during a major version release. When you upload
it, the revisions can still be double checked and approved or sent back
for further review, so it's better to go ahead and write the changes and
go from there.
As Sak said, reviewers can add sections, but if you're unfamiliar with
the other chapters in the book, or the contents of other books, you
might ask first if a topic is covered elsewhere already. If the topic
is already covered, perhaps it should be moved, or perhaps a brief
mention with a cross-reference would be better.
- Can reviewers change the sequence of various sections in the document
under review? Or is inserting a note recommending which sections can be
rearranged enough?
For this I'd suggest discussing in a comment in the document or here on
the mailing list. Rearranging a chapter can have far reaching
indications, affecting indexes, tables of contents, etc. Don't hesitate
to bring it up though. If you think a better arrangement would help the
user understand the material more clearly, by all means, put it up for
discussion.
Yes, reviewers can rearrange the sequence of sections in a chapter. I
think this is less likely to need discussion here first. Several
newcomers to the group have done major restructuring of some chapters
recently, without prior discussion, and the results have been definite
improvements.
Indexes and tables of contents fix themselves when they are updated,
so that is not a consideration IMO.
However, what can be affected is similar chapters or sections in other
books. For example, we try to keep all the introductory chapters at
much the same level of detail, and all the chapters about printing or
templates or customizing etc approximately the same (except for
component-specific differences), and so on.
Really major changes (e.g., in the contents and sequencing of chapters
in a book) may need to wait for another major release of the software.
We made some big changes between OOo2.x and OOo3, after compiling
quite a long wish list in the last year or so of OOo2.x.
--Jean
