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.
* The main skill set in tech writing is structured writing.
* Minor formating issues to the side, structured writing is really all about analysis - that is coming up with a properly structured understanding of the product's essential functionality and then letting that understanding guide the writing process.
* What better tool for performing a structured analysis of a system than structured systems analysis (i.e., data flow diagrams)?
You stated: "In my mind, what I need is task-based user assistance, not a data-flow diagram."
My response: You are right in that your end goal is task-based user assistance - not data flow diagrams. However to get to your task-based deliverable, you need to task analysis. Data flow diagrams are a task analysis tool. I know that alot of people think that they are related to computers, and divorced from what the end user is doing. Not true; I have an industrial engineering background and have used them to diagram completely manual systems - where only end users and their tasks exist.
Data Flow Diagrams differ from the more popularly know task anlaysis technique in that, only with Data Flow Diagrams are the interrelationships between the tasks rigorously defined. Definition of the interrelationships is the lithmus test of completedness in task analysis. For larger-scale efforts this lithmus test of completedness is critical.
Generic Richard
Julie Stickler <jstickler -at- gmail -dot- com> wrote:
I know I shouldn't even ask (because it's Richard, and I've heard your
"data-flow diagrams are the solution to everything" schpiel MANY times
before), but I am honestly curious.
I'm a user. I'm on deadline, the boss is hovering every five minutes
asking me if I'm done yet. But I'm struggling with my new softare,
trying to figure out how to do what I need to do. In desperation, I
click the Help link.
How on earth will a data-flow diagram help me get my job done? How
will documenting function boxes and how they lead to other function
boxes help me, the user? Because I'm currently revising a set of
features-based documenation, and I'm finding them to be very unhelpful
in telling me what a user can do with the software.
In my mind, what I need is task-based user assistance, not a data-flow diagram.
Please don't make me regret asking....
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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 tech44writer -at- yahoo -dot- com -dot-
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.
---------------------------------
Be a better Heartthrob. Get better relationship answers from someone who knows.
Yahoo! Answers - Check it out.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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-
