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.
What formatting do you use when you document your relatives? Auntie Jane, in a plain language reference, would be "Your auntie, Jane." Same thing here. The class tmZone is a class for time zones. In other words, it is a time zone class.
In this case, "time zone" is not a name. So you don't need any formatting at all. OTOH, I don't think I ever use that approach, unless there are many time zone classes, and I need to talk about them as a group. I always try to refer to a class or any other programming construct by its proper name, usually wrapped in <codeph>.
cud
From: Deanna Korth <deanna -dot- korth -at- gmail -dot- com>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
