Re: "Conventions Used in this Manual" wasRE: Emphasis

[Alexia Prendergast <alexiap -at- SEAGATESOFTWARE -dot- COM>]

I generally skip the obvious stuff such as "bold means this or that."
(I used to include it, but our localizers convinced us not to bother
because conventions tend to change depending on the language.)
And, as you said, if it's that cryptic, then I'm probably doing
something wrong.

However, I do include syntax conventions, such as "switches in []
are optional," and so on.

A.

--
Alexia Prendergast
Senior Technical Writer
Seagate Software
mailto:alexiap -at- sems -dot- com

>-----Original Message-----
>From:  Huber, Mike [SMTP:mrhuber -at- SOFTWARE -dot- ROCKWELL -dot- COM]
>Sent:  Wednesday, September 03, 1997 4:42 PM
>To:    TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU
>Subject:       "Conventions Used in this Manual" wasRE: Emphasis
>
>If it isn't obvious just from looking at any random page in the book
>(except for some specialized tables, charts, or graphics) you have a
>problem that a bit of ignored "front of the book junk" isn't going to
>solve.
>

 TECHWR-L (Technical Communication) List Information: To send a message
to 2500+ readers, e-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot-  Send commands
   to LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU (e.g. HELP or SIGNOFF TECHWR-L).
  Search the archives at http://www.documentation.com/  or search and
browse the archives at http://listserv.okstate.edu/archives/techwr-l.html