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.
We've recently had some good discussion re: this on the
Framers group. I tried out the various suggestions from
folks and decided on a para style that includes a warning
dingbat, indented text, and a frame above and below the
warning text. The frame above includes the word "Warning"
like this (D stands for dingbat):
Warning------------------
D texttexttexttexttext
texttexttexttexttext
texttexttexttexttext
--------------------------
We do the same thing with different top frames and dingbats
for tips and notes.
Previously, I used tables, but this way is easier for what
we are doing right now. If you want a sample, let me know.
You can also get samples from http://www.workingtogether.com/framemaker/templates.shtml
This is a great Frame resource.
>----------
>From: Brenda Burnett[SMTP:brenda -at- PRECISE -dot- AB -dot- CA]
>Sent: Wednesday, May 07, 1997 11:26 AM
>To: TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU
>Subject: Look & Feel (warnings, notes and hints)
>
>Hello People:
>
>I'm currently contracted to update and restructure the user and sys/admin
>documentation for a small software company. In this restructure I have
>placed various types of information that require more reader focus. I've
>divided these items into three categories: warnings, notes and hints.
>
>Initially I just bolded and changed the font of the first word (either
>warning, note or hint) and added a line above and below the paragraph.
>I'm wondering if there is a better way to do this. I've played around
>with placing warnings in a lightly shaded box and leaving notes and
>hints alone. Perhaps even placing hints in the margin area. We're working
>with 7x8.5 paper so there isn't a whole lot of room on a page.
>
>Any idea? What's being done out there? what have you seen and liked (or
>didn't like)? I'd appreciate any feedback you have to offer.
>
>Brenda Burnett
>"Contractor at Large"
>brenda -at- precise -dot- ab -dot- ca
>
> TECHWR-L (Technical Communication) List Information: To send a message
>to 2500+ readers, e-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send commands
> to LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU (e.g. HELP or SIGNOFF TECHWR-L).
> Search the archives at http://www.documentation.com/ or search and
>browse the archives at http://listserv.okstate.edu/archives/techwr-l.html
>
TECHWR-L (Technical Communication) List Information: To send a message
to 2500+ readers, e-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send commands
to LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU (e.g. HELP or SIGNOFF TECHWR-L).
Search the archives at http://www.documentation.com/ or search and
browse the archives at http://listserv.okstate.edu/archives/techwr-l.html
