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: Re[2]: accuracy & phrasing in documentation From:"REAL programmers don't document..." <ALBANO -at- PROMIS -dot- COM> Date:Wed, 27 Oct 1993 09:43:00 UT
Speaking of "intentionally vague", there are some things that
users don't need to know... For example, what gets initialized
when you turn your PC on. All they really need to know, usually,
is that once it's on, they can start their application (or whatever).
Programmers, being detail-oriented of necessity, often want to
include things that are of interest only to other programmers
in the user documentation. The user documentation should be
suitably vague about the behind-the-scenes stuff.
/albano -at- promis -dot- com
