Re: "use-case based documentation"

Subject: Re: "use-case based documentation"
From: Robert Lauriston <robert -at- lauriston -dot- com>
To: Julie Stickler <jstickler -at- gmail -dot- com>, Technical Writing <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Tue, 3 Feb 2015 09:55:59 -0800

I'd take that to mean that the examples should reflect expected
real-world uses of the software.

For example, if a developer gives me a sample application that has
database table columns named "foo," "bar," and so on, I'll change
those to something like FName, LName, EmployeeID, etc.

On Tue, Feb 3, 2015 at 9:47 AM, Julie Stickler <jstickler -at- gmail -dot- com> wrote:
> One of our Product Managers keeps using the phrase "use-case based
> documentation" as in, that's something she wants the doc team to provide.
> I suspect what she means is task based documentation, but she insists
> that's not what she means.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Doc-To-Help: The Quickest Way to Author and Publish Online Help, Policy & Procedure Guides, eBooks, and more using Microsoft Word | http://bit.ly/doctohelp2015

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

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:
"use-case based documentation": From: Julie Stickler

Previous by Author: Re: publishing large numbers of docs to SharePoint Wiki pages
Next by Author: Re: "use-case based documentation"
Previous by Thread: "use-case based documentation"
Next by Thread: Re: "use-case based documentation"


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

Sponsored Ads


Sponsored Ads