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: Documentation for Financial Software From:Richard Yanowitz <ryanowit -at- NYCT -dot- NET> Date:Thu, 7 May 1998 15:07:00 -0400
Here as in so many other places, there is no pre-existing answer.
You always start by asking: what is going to help my readers most? What
are they looking for?
Polling people is a good way to find this out.
Sounds as if your readers would likely benefit for calculation info.
Layout can solve a lot of the problem here--e.g., a table column that
explains calculations as needed and doesn't intrude the rest of the time.
Ultimately you do what the person/people in charge says/say. But if you're
involved in the decision--if your advice and expertise are valued--explain
why you think it should be such-and-such; and help yourself out by having
talked to relevant parties--and even better, having relevant parties,
including the final decision-maker, talking together.
It's great that you seek advice and reality checks, but only you, really,
can know the exact needs and culture you're dealing with. You make up the
rules in context.
Good luck.
Richard Yanowitz, NYC
ryanowitz -at- bigfoot -dot- com
Freelance writers (including tech writers): join the National Writers Union
Web site: http://www.nwu.org/nwu/
E-mail: nwu -at- nwu -dot- org
