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.
Maybe I'm having a bad day, but I'm doubting
the value of using the procedural style outlined
in the Microsoft Manual of Style for Technical
Publications in my help topics.
I'm documenting a financial ASP application. The
primary - and possibly the only -- documentation
will be the help system I'm developing. Currently,
I have planned for 150+ help topics, split into
three "levels" of assistance (general, procedural,
and field-level).
Every screen/page in the app has an average of
15 drop-down lists and text boxes. The average
user will be an experienced financial professional,
but they won't necessarily be an experienced
ASP application user.
I'm concerned that I will p***-off my users by
using the MMoSTP procedural style, i.e. "In the
Currency drop-down list, select the currency
of this transaction." I suspect that this kind
of detail is unnecessary, based on the level of
financial knowledge the product's users will have.
It also makes for *very long* procedures.
I'm starting to think that a high level procedural
style such as the following is more appropriate:
1. Click the General tab and provide values
for your investment. For definitions of the fields
on this screen, see <field-level help topic>.
2. Click the Administration tab and provide cash
flow information for your investment. For definitions
of the fields on this screen, see <field-level help
topic>.
3. Click the General tab.
4. In the Ticket Status drop-down list, select Done.
5. Click the Forecast tab to view cash flows that
were generated for your investment.
6. Click Submit.
Which is better in this situation-- detailed or
high-level? What are some alternative procedural
styles that I could use in this situation?
Thanks,
Rowena
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Announcing new options for IPCC 01, October 24-27 in Santa Fe,
New Mexico: attend the entire event or select a single day.
For details and online registration, visit http://ieeepcs.org/2001
Your monthly sponsorship message here reaches more than
5000 technical writers, providing 2,500,000+ monthly impressions.
Contact Eric (ejray -at- raycomm -dot- com) for details and availability.
---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.