Bold: replaced word in original text
Normal: Citation from original text
Italic: Comment
Suggestions
IMPROVEMENT: something to add, to be defined by document owner
TYPO: a suggestion for correcting a found typo
What has been quality checked?
Compliance with Functional Specifications
[ ] Make sure it is in line with the Functional and Technical Specifications
[x] Make sure it is in line with the rest of the documents
[ ] Make sure the manual features a product overview
[x] Make sure the manual features the box's content listing
[ ] Make sure the configuration/set up instructions are clear
[ ] Make sure the document contains the Relevant Safety Information: Safety warnings and precautions, Explanation of any regulatory compliance (e.g., FCC, CE), Battery usage and disposal.
[ ] Make sure the manual contains Technical Specifications: dimensions, weight, power requirements
[ ] Make sure the manual contains environmental tolerance data: Operating Temperature, Humidity
[ ] Make sure the manual contains a glossary if applicable
[ ] Make sure the manual contains a table of contents
Readability
[x] Make sure paragraphs are mostly never over 3-4 lines long.
[x] Make sure the document features at least 1/10th visuals.
[ ] Make sure the document features some admonition for information hierarchy.
[x] Ensure accessibility by checking Links, Image alt attributes, and presence of Table of content
[x] Make sure the heading logic is clear (no H2 in an h3 for instance)
Coherence
[ ] Make sure the document doesn't contradict itself and with the rest of the documents.
Spell Check
[ ] Make sure the document is written in a professional, idiomatic American English
Global Suggestions
[ ] User Manual is missing some of the mandatory content (law, safety, regulations etc. described above)
Detailed Suggestions
Specifications
IMPROVEMENT: 7 days (Working time may vary depending on the usage) What kind of usage ? two unlockings a day ?
Step by Step
[x] IMPROVEMENT: Connect to the provided USB cable..
IMPROVEMENT: Once the device is fully charged... how do you know that the device is fully charged
[x] IMPROVEMENT: You can check the battery level by looking... How can the user look at the application if they haven't installed it yet, in the following step?
[x] IMPROVEMENT: Use the application to lock the cable to the device... How does the user know that it is successfully locked? is there a sound?
[x] TYPO: Make sure the device is securely attached to the skis .
LABELS
Text Format
Bold: replaced word in original text Normal: Citation from original text Italic: Comment
Suggestions
IMPROVEMENT: something to add, to be defined by document owner TYPO: a suggestion for correcting a found typo
What has been quality checked?
Compliance with Functional Specifications
Readability
Coherence
Spell Check
Global Suggestions
Detailed Suggestions
Specifications
IMPROVEMENT: 7 days (Working time may vary depending on the usage) What kind of usage ? two unlockings a day ?Step by Step
IMPROVEMENT: Once the device is fully charged... how do you know that the device is fully charged