On 12/21/2009 2:47 AM, 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.
- 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.
Thanks,
Sak.
The ToC and alphabetical index are generated automatically, according to
the subheads in the case of the ToC. However, the indexing could pose a
problem because the first use of an index item could change after
sections change. Still change bars in the margin and tracking entries,
plus comments, could help the indexer when modifying index entries.
Gary
