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.
I don't think IEEE is referring to procedures when they say "informative
text," but rather to introductory paragraphs, theory of operation, etc.
Their proscribed placement is to place general notices at the beginning
of a document and warnings that are procedure-specific at the steps to
which they apply.
Gene Kim-Eng
----- Original Message -----
From: "Kathleen MacDowell" <kathleen -at- writefortheuser -dot- com>
> However, I'm not so sure I agree with IEEE's guidelines for warnings.
> They
> say not to include warnings in informative text, which I'm assuming
> would
> include a set of procedures.
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-