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:Re: Acronyms in section headers From:Bev Parks <bparks -at- HUACHUCA-EMH1 -dot- ARMY -dot- MIL> Date:Sun, 17 Dec 1995 11:02:38 MST
I agree with you in that the section headers should match the
screen titles. If I'm scanning a manual looking for the section
about a particular screen, my eyes/mind will much more quickly
lock on the header that matches the screen title *exactly*. I
don't want to have to mentally process a bunch of extra words in
order to know that, yes, this is the section I'm looking for.
Work: bparks -at- huachuca-emh1 -dot- army -dot- mil
Home: bparks -at- primenet -dot- com
> I'm documenting a fair number of screens and would like your feedback. A lot
> of these screens have acronyms in their titles. For consistency between the
> program and the documentation, I have been leaving the acronym in my section
> headers (so a user can find a
> specific screen more easily), and then spelling out and defining the acronym
> in the first body paragraph. However, somebody brought up that I should
> consider spelling out the acronym in both the header and the body text. Any