I'm writing a technical user guide for a piece of software and am not sure whether I should be using a comma or not when giving instructions. Which of the following is correct?
To add a new item click on a 'File' menu and then select 'Add'.
OR
To add a new item, click on a 'File' menu and then select 'Add'.
Answer
Yes, use the comma. It makes the sentence clearer than if there's no comma. Sometimes commas are unnecessary, and sometimes they help. In this case, I had to read the comma-less sentence twice to separate item and click. Readers don't like have to read the same thing twice to be able to understand it. If what you're saying is inherently difficult to understand, that's one thing, and the readers have to deal with their own intellectual limits. But if it's merely a matter of writing mechanics and punctuation, it's your job as a technical writer to make everything you write as clear and as easy to understand as possible. That's what I try to do all day long.
No comments:
Post a Comment