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.
All:
As a follow up to my question regarding document types for software
products, I have another question. I have searched the archives, haven't
seen anything useful. My question is, what the heck is the difference
between reference manuals and user guides. I always thought they would be
pretty similar, have a lot of the same information such as theory,
definitions, screen shot descriptions, and the like, but the user guide also
has steps and procedures. Granted, my experience has been strictly user
guides that were pretty exhaustive including theory, screen shots and
explanations, acronyms, and so on. Should user guides contain mainly step by
step procedures, without all of the screen shots explanations, theory, and
all that other stuff? Do I need to rethink what goes in user guides?
Can someone enlighten me on the differences (preferable without flaming) on
the user guides and reference guides? Is there a web site that talks about
the different kinds of documentation including definitions? Or is this
really different for each individual company and lacks a standard throughout
the universe?
Kevin Feeman
Technical Writer
MicroMass Communications Inc.
www.micromass.com <http://www.micromass.com/>
(919) 851-3182 Ext. 3105
kevin -dot- feeman -at- micromass -dot- com
