Re: Phrasing question in documentation

Subject: Re: Phrasing question in documentation
From: "Peter Neilson" <neilson -at- windstream -dot- net>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Mon, 31 Aug 2015 20:56:21 -0400

On Mon, 31 Aug 2015 16:26:21 -0400, Matthew Hunt <morfran -at- gmail -dot- com> wrote:

I'd call it something catchy like:
"Report from week of"
And lobby the programmers to only allow Mondays to be selected. For me, the real confusion is in letting users select dates that have no meaning.

Yes, Google Calendar has something like that. After your search has found your candidate event, you must select the desired event's day, NOT the event itself. I have a work-around, but I shouldn't have to.

I have handled these issues by asking the developers, "How would you prefer that I document this action?
- 1. According to the written specification?
- 2. According to what my notes say about what I thought you said in the meeting?
- 3. According to your comments in the code?
- 4. According to how the code actually performs?
- 5. The way that I think it should work?"

I think that at least once I was told, "There shouldn't be any difference."

And of course there shouldn't.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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


References:
Re: Phrasing question in documentation: From: Matthew Hunt

Previous by Author: Re: Recommendations for programmer's guides
Next by Author: RE: Business Glossary
Previous by Thread: Re: Phrasing question in documentation


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

Sponsored Ads


Sponsored Ads