Professional Documents
Culture Documents
Rewrite the following material with attention to grammar, spelling, clarity, and
conciseness. If you
feel no changes are required, write “no changes.” (10 marks)
1. The discussions in this chapter are as follows:
• To prepare for installing
No changes require
• Installation of the program
Installation of the programme
• How to configure the program
How to configure the programme?
• Do you want to save the earlier version?
Do you want to save the earlier version?
• Using the program
No changes require
3. This Chapter provides the information you need to install the software.
This chapter provides the information you need to instal the software.
9. Nancy is among the few who want to continue working with the company.
No changes require
10. The conference was scheduled for July 30th, 2020, in San Francisco.
No changes require
2. Harish was planning to attend his friend’s wedding on June 1, but at the last minute he found
out he had jury duty, so he couldn’t attend the wedding, and he felt really guilty about it.
• Harish had intended to attend a friend's wedding on June 1, but he found out at the
last minute that he had jury duty, so he couldn't go, and he felt terrible about it.
Product documentation can be a valuable marketing tool for both your product and
your company. Because customers rely on product information to make purchasing
decisions, product documentation can be used to support marketing efforts.
• Product documentation has a range of content targeted at different audiences. This
can be a valuable source for marketing automation strategies.
• The content is full of keywords, links and is well structured; all of which improves
SEO.
• High-quality product documentation ensures customers get the full value out of their
product, and this builds loyalty.
The purpose of product documentation is to communicate relevant information about the product to
the people who need that information, when they need that information.
For example, a developer requires API reference when integrating with a product, or a first time user
requires instructions about setting up the product when taking it out of the box for the first time.
• Clear, concise and unambiguous – It should go without saying that it needs to be in a language
that the reader understands.
• Accurate and comprehensive: If the information is correct, but parts of the product are not
covered, the reader will not be able to achieve their goal.
• Findable and accessible: An often overlooked aspect of quality is its usability in the context of
the product. If a user can’t find the information, then it doesn’t matter how well it is
constructed or how accurate it is, the objective will not be met.
2.Design a checklist of items that would be included in documentation review. (This check list is
shared with technical writers, editors, and reviewers.)
Item Y N Comments/Changes
All known
audiences/customers/users are
☐ ☐
described thoroughly and
accurately.
Company-specific product
names and industry
terminology used consistently
☐ ☐
throughout the document
(e.g., proper nouns
capitalized).
Copy Review