Re: Class name formatting

Subject: Re: Class name formatting
From: Deanna Korth <deanna -dot- korth -at- gmail -dot- com>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Sun, 18 Oct 2020 13:17:18 -0500

I'm setting up a documentation department from scratch. I'm still
researching tools. I'm hoping for Flare, but I'm open to suggestions.

So you would use monospace for the plain text name? (alias? is that what
it's called?)

Like this?

Class name:


Short description:

List of time zones

Long description:

The <code>time zone</code> class represents ...

On Thu, Oct 15, 2020 at 5:07 PM Deanna Korth <deanna -dot- korth -at- gmail -dot- com> wrote:

> What formatting do you use when you document the plain language name of a
> class? For example, if the class name is tmZone, what formatting do you use
> when you're writing about the "time zone" class?
Visit TechWhirl for the latest on content technology, content strategy and content development |


You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-leave -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit for more resources and info.

Looking for articles on Technical Communications? Head over to our online magazine at

Looking for the archived Techwr-l email discussions? Search our public email archives @

Class name formatting: From: Deanna Korth

Previous by Author: Re: Class name formatting
Next by Author: Re: Best ebook software or method for a 250-page book from PDF to Kindle
Previous by Thread: Class name formatting
Next by Thread: Re: Class name formatting

What this post helpful? Share it with friends and colleagues:

Sponsored Ads