Creating a Troubleshooting Guide
What’s wrong with these sentences? 1. Secretaries are responsible for taking dictation, answering phone calls, and the coffee. 2. Please send the following information: a) How do you transport the vehicles to the salesroom b) Average number of test drives before the vehicle is sold c) Deciding the percentage to go to sales representatives Non-parallel grammar
What’s wrong with these sentences? Giant Waves Down Queen Mary’s Funnel • • Squad Helps Dog Bite Victim McDonald’s Fries Holy Grail for Potato • Farmers Vegetarian Fed Hens • Telegraphic style aka “ugg speak”
What’s wrong with these headings? The camera Lens is Scratched. Inconsistent The Phone Won’t turn on. capitalization The Nintendo logo has rubbed off. Solution 1 Use sentence case: The camera lens is scratched. Capitalize first The phone won’t turn on. letter and proper The Nintendo logo has nouns only. rubbed off.
What’s wrong with these headings? Solution 2 The camera Lens is Scratched. Use title case: The Phone Won’t turn on. Capitalize The Nintendo logo has rubbed everything except off. • articles a, an, the • conjunctions The Camera Lens Is Scratched. and, or, but, The Phone Won’t Turn on. etc. The Nintendo Logo Has • prepositions Rubbed off. on, over, by, to, etc.
Use correct phrasing. Problem Causes Solutions Phrased as Specifically Suggested, but problem described not yet described —link to the repair guide Incorrect: Incorrect: Incorrect: Exposure Lighting Remove the old light by twisting. . . Correct: Correct: Correct: You may Underexposed Insufficient need to replace photos lighting the light.
Check the list grammar: Problems Causes
Use headings correctly. Include text under each heading. Heading Text Heading Text
Use headings correctly. Ensure the text makes sense without reference to the heading—use topic sentences under each heading. And avoid "naked this ". No! Yes!
Check the list grammar: Fix parallelism Repair telegraphic style
Check for the following: • Links to at least 5 different hardware repair guides. • Grammatical consistency in the table of contents, headings, and subheadings. • Consistent capitalization. • Text under all headings. • Avoidance of telegraphic style. • Topic sentences under ALL headings.
Recommend
More recommend