Posted by: episystechpubs | May 8, 2017

Editor’s Corner: Style Guide Updates

JHA and Symitar folks, there are some updates in the May version of the JHA Style Guide for Technical Communication. I’m only listing two items that come up a lot, so please be sure to check out the What’s New in the Style Guide – May 2017 section in the style guide to see all the updates.

Sunset/End of Life

Guideline
The terms sunset and end of life can be used internally, but should never be used in documents that are external-facing.

In external correspondence, presentations, and conversations, use the terms no longer supported and no longer offered.

Use no longer offered for a product that we no longer sell, but that we will continue to support for the foreseeable future for clients who are using the product.

Use no longer supported for a product that we no longer sell and for which we have established a specific date that JHA will no longer maintain and support the product. Clients may be encouraged to move off the product (and onto an alternative), to cease using it, and to destroy or return any copies.

Unavailable/Dimmed/Grayed Out

Guideline Example
Use unavailable or not available to refer to items on the user interface that are in an unusable state.

Do not use disabled.

Correct:

§ The Cut button is not available if you have not selected text.

§ If you have already saved a document, the Save button is unavailable until you modify it again.

Incorrect:

§ The Cut button is disabled if you have not selected text.

§ If you have already saved a document, the Save button is disabled until you modify it again.

To describe the appearance of an unavailable item, use appears dimmed. Avoid grayed out unless the use of that term is necessary for clarity. Correct:

§ If an option appears dimmed, it is not available for the document type you selected.

Jackie Solano | Technical Editor | Symitar®

8985 Balboa Ave. | San Diego, CA 92123 | Ph. 619.542.6711 | Extension: 766711

Symitar Documentation Services

NOTICE: This electronic mail message and any files transmitted with it are intended
exclusively for the individual or entity to which it is addressed. The message,
together with any attachment, may contain confidential and/or privileged information.
Any unauthorized review, use, printing, saving, copying, disclosure or distribution
is strictly prohibited. If you have received this message in error, please
immediately advise the sender by reply email and delete all copies.


Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s

Categories

%d bloggers like this: