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.
John L Patterson <a342jpatters -at- ATTMAIL -dot- COM> wrote:
>We are developing an in-house style guide for regulatory >manuals. From your experience, please help us resolve the >following issues:
John:
Most of the questions you ask are design questions, and design usually
depends on context.
For example, if the manual is part of a series, then using its name in a
header is important. If the company wants to promote itself, using its
name in the header and footer might be more important. In other cases,
the chapter title or the first header on the page might be useful for
scanning purposes. It all depends.
You may find a few conventions, such as avoiding leading dots, but, on
the whole, you need to think about your company's aims before any answer
to your questions mean very much.
And, of course, even conventions should be broken if you have a good
reason.
