Expert: Kaylyn Anderson - 10/5/2008

Question
Hi there,
I am in the process of assisting with writing a manual for users to utilize a computer program.

1.) Is there any "How to reference guide" I could refer to?
2.) Is there a standard in place when referring to a screen, a window, a key, etc.  For example - do you use "" or < > or ??
3.) Can you use I/we/you?
anything you have to offer would be appreciated.
Thanks
Michelle

Answer
Dear Michelle:
Thank you for writing AllExperts.

#2
When referring to a screen, a window, a key, etc., in order of importance:
  SCREEN title (Caps and Bold work); It's even better to capture the screen.
  WINDOW title (same, if you want or just bold; it's even better to capture the window.
  KEY (here, you could use a picture of a key or some other relevant icon.)

Users often need visuals to make sense of information.

#3
In computer help books, you may certainly use second person (you). I would eliminate first person (I, we) in these manuals. Always make it about the other person. Some writers in the industry use cultural names instead of 2nd person. Jose, Mary, Stefano, etc. They do so to make it personal. I prefer 2nd person. The other is your choice.

#1
I do not know of a how-to reference guide to writing computer manuals. I always developed my own. "...for Dummies" series is good. I suggest looking at one of those books because they are consistent.

Again, thank you for writing.

Communicate with Success!
Kaylyn

WriterSeries.com