Re: Note styles

Subject: Re: Note styles
From: Robert Lauriston <robert -at- lauriston -dot- com>
To: TECHWR-L Writing <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Tue, 16 Oct 2018 10:33:17 -0700

What tool are you using? Most of the ones I've used have tags for
Note, Caution, and Warning. The format varies depending on what I
publish to.

Depending on your industry and the type of document, icons may be
required and there may be standards for their appearance.

https://www.safetysign.com/help/h38/2007-revision

On Tue, Oct 16, 2018 at 5:52 AM Sion Lane <sion -dot- lane -at- unit4 -dot- com> wrote:
>
> We currently use appropriate icons, indentation and a different background to indicate notes, tips and warnings in our help topics and pdf content. A proposal has been made that we also use autonumbering to add the word 'Note' 'Tip' etc.
>
> I feel this is overkill, the icon in conjunction with the background colour act as a visual representation of that word so to add the word as well makes it almost tautological. The nature of the message should also be obvious from the text itself. I should add that we do not currently have an 'About this Help' topic that explains the icons and there is no desire to add one.
>
> What are other people's opinions?
>
> Am I crazy to be so bothered about this?
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> Visit TechWhirl for the latest on content technology, content strategy and content development | https://techwhirl.com
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> You are currently subscribed to TECHWR-L as robert -at- lauriston -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
> http://www.techwhirl.com/email-discussion-groups/ for more resources and info.
>
> Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com
>
> Looking for the archived Techwr-l email discussions? Search our public email archives @ http://techwr-l.com/archives
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Visit TechWhirl for the latest on content technology, content strategy and content development | https://techwhirl.com

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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
http://www.techwhirl.com/email-discussion-groups/ for more resources and info.

Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com

Looking for the archived Techwr-l email discussions? Search our public email archives @ http://techwr-l.com/archives


References:
Note styles: From: Sion Lane

Previous by Author: RE: Ig Nobel documentation
Next by Author: Re: Ig Nobel documentation
Previous by Thread: RE: Note styles
Next by Thread: RE: Note styles


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

Sponsored Ads


Sponsored Ads