Re: Initial Doc Focus: Concepts or Procedures?

Subject: Re: Initial Doc Focus: Concepts or Procedures?
From: "Gene Kim-Eng" <techwr -at- genek -dot- com>
To: "Pro TechWriter" <pro -dot- techwriter -at- gmail -dot- com>, <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 23 Jul 2008 17:05:42 -0700

My thoughts on this are as a software user and frequent
beta tester, not as a writer. If I didn't already have a grasp
of the "high level concepts" behind a program, I wouldn't
be spending any time beta testing it. I want to know how
to make the bloody thing work.

Gene Kim-Eng


----- Original Message -----
From: "Pro TechWriter" <pro -dot- techwriter -at- gmail -dot- com>
> I have a very short time frame to produce some documentation for some
> beta
> software.
>
> My thoughts that the users will need instructions to use the
> software, with
> some basic concepts related to the tasks thrown in. Some folks (um,
> "programmers") disagree with that approach. They want high-level
> conceptual
> information instead and some "isn't the product wonderful" text. They
> basically said "we don't need no stinkin' steps."
>
> Weigh in, please. I am interesting in hearing some *technical
> writer's*
> experience and opinions on this one.

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

Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more.
http://www.DocToHelp.com/TechwrlList

True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com

---
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-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

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


References:
Initial Doc Focus: Concepts or Procedures?: From: Pro TechWriter

Previous by Author: Re: Just can't get there from here....<solved>
Next by Author: Re: Initial Doc Focus: Concepts or Procedures?
Previous by Thread: Initial Doc Focus: Concepts or Procedures?
Next by Thread: Re: Initial Doc Focus: Concepts or Procedures?


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


Sponsored Ads