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.
> I think that you can remove screen shots from the documentation.
> If you guide the users step-by-step and use the same labels as in
> the product UI, then everything should be fine.
That depends entirely on the complexity of the interface. Using the right
label is essential, but if I (as the reader) don't know where to find the
silly thing in a complex UI, a little bit of graphical assistance will save
me time, page flipping and frustration.
And by "little bit" I certainly don't mean a huge full-screen capture. Just
give me a tidy, well-cropped picture of the thing I'm looking for. And if it
is something that may not always be visible, give me a link or cross
reference to the info I need to get to the thing.
Few things annoy me more than "help" that gives me half an answer and fails
to tell me where I can find the other half.