Phrasing question in documentation

Subject: Phrasing question in documentation
From: Joe Weinmunson <litlfrog -at- gmail -dot- com>
To: "techwr-l -at- lists -dot- techwr-l -dot- com" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Mon, 31 Aug 2015 10:43:22 -0400

Our programmers recently added a new financial report called "Payments
Summary" to the business software we sell. One of the menu options on the
report is misleading and I'm looking for advice on what to call it. The
option is currently labeled "Start Date," but the program doesn't actually
interpret that as "start adding up payments beginning on this date." The
report goes by weeks interpreted as beginning on a Monday. Two examples:
A) I run a report with a Start Date of Thursday, Feb 5 and tell the program
to group payments by weeks. I get a list of payments made in different
formats (Checks, Visa, MC, direct debit, etc.) for the week of 2/2â2/8,
2/9â2/15, 2/16â2/22, etc. See, the "start date" I chose, 2/5 falls in the
week of 2/2 through 2/8.
B) I run the report with the same Start Date of Thursday, Feb 5, but this
time I tell the program to group payments by days. I now get the list of
payments in the same format, but for Monday 2/2, Tuesday 2/3, 2/4, 2/5,
2/6, and Weekend (2/7â2/8).

It took ME a couple of minutes to understand how this works when the
programmer explained it to me; it's going to really puzzle our users and I
want to get down on tech support calls by changing what we call the "Start
Date" option. "Week w/ Date"? "Date Falls In Week"?

--
Joe Weinmunson

âWhat you read when you donât have to determines what you will be when you
canât help it.â
--Oscar Wilde
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Learn more about Adobe Technical Communication Suite (2015 Release) | http://bit.ly/1FR7zNW

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-leave -at- lists -dot- techwr-l -dot- com


Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwhirl.com/email-discussion-groups/ for more resources and info.

Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com

Looking for the archived Techwr-l email discussions? Search our public email archives @ http://techwr-l.com/archives


Follow-Ups:

Previous by Author: Re: "Software Technical Writing is a Dying Career"
Next by Author: Re: Wiki for Product Documentation
Previous by Thread: Re: Anyone using IBM Kenexa?
Next by Thread: Re: Phrasing question in documentation


What this post helpful? Share it with friends and colleagues:

Sponsored Ads


Sponsored Ads