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:Style guide for Environment, Health, and Safety? From:Geoff Hart <ghart -at- videotron -dot- ca> To:TECHWR-L Writing <techwr-l -at- lists -dot- techwr-l -dot- com>, Christina <c -dot- s -dot- eftekhar -at- gmail -dot- com> Date:Wed, 26 Aug 2009 12:12:15 -0400
Christina wondered: <<I am currently a technical writer / document
manager at an EHS department of a pharma company. I am harmonizing
procedures, web guidance, manuals, etc. for a world-wide audience (R&D
scientists primarily, EHS staff and regulators secondarily). I cannot
find which style guide is standard or even a preference for EHS
writers>>
First off, you need to be aware that no industry or genre has a
universally accepted style guide, though there are guides that are
widely accepted, such as APA for psychologists, AMA for medical
writers, ACS for chemists, and so on. The true purpose of a style
guide is to provide useful guidance, so the trick is to define what
style problems you need guidance with, and pick a guide that provides
the necessary guidance.
A useful guide for the sciences is the Council of Science Editors
guide. See my review at <http://www.geoff-hart.com/articles/2007/CSE-guide.htm
>. It may or may not meet your needs, but it's a useful reference to
have.
It may also be worthwhile asking your question via STC's ESH SIG (http://www.stcsig.org/esh/
). Someone there may be able to recommend an appropriate guide.
------------------------------------------------------------------------
Geoff Hart (www.geoff-hart.com)
ghart -at- videotron -dot- ca / geoffhart -at- mac -dot- com
------------------------------------------------------------------------
Effective Onscreen Editing: http://www.geoff-hart.com/books/eoe/onscreen-book.htm
------------------------------------------------------------------------
Free Software Documentation Project Web Cast: Covers developing Table of
Contents, Context IDs, and Index, as well as Doc-To-Help
2009 tips, tricks, and best practices. http://www.doctohelp.com/SuperPages/Webcasts/
Help & Manual 5: The complete help authoring tool for individual
authors and teams. Professional power, intuitive interface. Write
once, publish to 8 formats. Multi-user authoring and version control! http://www.helpandmanual.com/
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-