TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
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:
<code>tmZone</code>
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 | https://techwhirl.com
