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:John Gilger <JohnG -at- MIKOHN -dot- COM> Date:Thu, 7 May 1998 10:08:53 -0700
How about just saying: "Using the formula...this value is calculated."
or words to that effect. There are numerous finance textbooks that lay
out the mathematical formulae (some quite complex) that many financial
experts have probably forgetten in this day of financial calculators.
You may think of including a list of the variables and where they are
entered, if that is not clear.
hth
John
-----Original Message-----
From: Cornela King [mailto:cornela -dot- s -dot- king -at- ARTHURANDERSEN -dot- COM]
Sent: Thursday, May 07, 1998 4:07 PM
To: TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU
Subject: Documentation for Financial Software
To those of you who write documentation for financial software ...
When do you document the calculations that are going on behind the
scenes?
In my case, the users are internal financial planners, accountants,
subject
matter experts. They tend to be on the anal side when it comes to
numbers.
On the other hand, my product sponsor balks at the idea of providing all
the calcs (basically, the code) for the users.
Any advice?
Please copy me in directly on your responses. I get the digest version
of
this list.
