3. Reviewing stage in documents
Reviewing differ from testing.
Reviewing differ from editing
Purpose of Review
Reviewing throughout the documentation
process
4. The last major step for most technical documents is one
or more reviews. You may be too familiar with your
document to see such things as gaps in information and
inappropriate language. In addition, you may lack
certain technical or managerial knowledge necessary
for the document to achieve its purpose.
5. For these reasons, writers of technical and scientific
documents may ask peers to review their manuscripts
for accuracy, clarity, coherence, and appropriateness. In
many cases, a technical expert will review the
document for technical content.
6. A technical editor may review the document to ensure
that it conforms to the organization's style and to
correct any remaining problems. There may be legal
reviews as well. Finally, a supervisor or a manager
may review the document to ensure that it achieves the
organization's purpose and is appropriate to the
audience.
7. The concept of the review stage is simple. In most
cases, multiple users will review the document and will
convey the errors, corrections, and suggestions they
want in the document to the author(s). During the
review phase or process, reviewers generally benefit
from collaborating with each other, improving their
productivity.
8. Review
Through reviews we ensure that we are building the
Product the right way using the right checklists,
guidelines etc.
9. Review
Output of reviews is a nearly perfect set of
documents e.g. SRS, HLD, LLD, Test Plan etc.,
plans, specifications, code.
Review happens before testing
Review maps to CMMI process area “Verification”
10. Testing
Through Testing, we ensure that we have built a
product that meets customer requirements by testing
the product against the test cases.
11. Testing
Output of validation, on the other hand, is a nearly
perfect, actual product.
Testing happens towards the end after the reviews
Testing maps to CMMI process area “Validation”
12. Revising :
is the reading of your manuscript to organize your
thoughts on paper to match the thoughts in your mind.
Revising takes place at the level of the sentence,
paragraph or higher.
13. Editing:
tests each word and phrase to see that it is accurate,
appropriate, or necessary, changing the language more
than the ideas. Editing is more stylized and mechanical
work, taking place at the level of the sentence or word.
14. If possible, put your first draft away for a day . Then revise your
document in stages , saving changes for last stage. Revise for
organization then revise the content for accuracy and
appropriateness. Finally , edit your paragraphs and sentences to
improve their clarity, conciseness and coherence, and to fix any
problems in grammar, spelling and punctuation.
Overall improvement
Accurate and up-to-date documents
Concise Information
Satisfaction
Improve the quality of documents
Make appropriate changes to the documentation and track the
changes that were not made (and why not).
15. Whether print or HTML‐based, the life cycle of a
document is comprised of five stages: creation, review,
approve, update and publish. Let us look, first at the
document creation stage to view how it participates in
the document review process,
16. After an author has completed the initial draft of a
document, it must be made available to a group of
reviewers. The most common online formats for
documents are HTML and PDF. Each has its own
advantages and, to an extent, disadvantages.
create
update
Review Approve Publish
17. The concept of the review stage is simple, but it can be
time‐consuming and error‐prone. In most cases,
multiple users will review the document and will
convey the errors, corrections, and suggestions they
want in the document to the author(s).
18. Now that the review stage is completed, the approval
stage begins. During this stage, the person(s)
responsible for the approval of the reviewers’
comments can resolve duplicate or conflicting
information and requests.
When the change requests and corrections have been
accepted, they are assigned to the author so the
document can be updated.
19. During the update stage, the author makes the approved
changes to the original document, having previously
received the reviewers’ approved change requests and
corrections. After the author has completed updating
the document with the changes, the document or Web
pages move either to the publish stage or are routed
back to the review stage.
20. The publish stage is the final step of the review
process. The documents or Web pages are published
and made available to the appropriate audience.
create Review
Update
Approve Publish
