Software Documentation


© Janice Karin

Lesson 7: Editing And Reviews

Which comes first - Reviewing or Editing?

In general, editors like to be the last person to see a book before it's released. If you have actual editors chances are you'll want to go through the review process before the editing process.

Alternately, if you're fairly confident that there won't be massive changes needed after the review, you could propose simultaneous review and edit periods. You could then offer the finalized, post-review document to the editors for a brief final edit to ensure you didn't violate standards when you integrated the review comments if that would make them more comfortable. I like this approach as it gives me the chance to integrate all requested changes at once rather than having to go back and forth multiple times with different people making a handful of changes each time.

If you're using peer or especially self editing, I recommend editing before the review process. That ensures other eyes have seen the document after your edits and gives you another little check in the process.



Previous Page  1  2  3  4  5  6  7  8   Next Page

Print this Page Print this page