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: Quick-start guides? From:Damien Braniff <Damien_Braniff -at- PAC -dot- CO -dot- UK> Date:Tue, 1 Jun 1999 08:00:18 +0100
I agree with Jane that it's very problematic to leave things out of the
documentation unless you know your audience VERY well indeed. I can see that it
is sometimes a question of what goes in versus time and effort available but I
think as much as is possible should be documented. All in favour of quick start
guides, basic user guides etc. On one product we had the User manual was a
large A4 folder - scared the hell out of some users just looking at it. We did
a basic user guide covering the main day to day features and re-names the User
Manual to User Reference Manual. Talking to users it made a big difference -
they liked the little A5 user booklet and weren't at all put off by a large
REFERENCE manual that they might occasionally have to dip into. Feeling was
that the User Manual was something they felt they should know but a Reference