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.
Re: Documentation Correctness was Re: How many levels of indents and heads are reasonable?
Subject:Re: Documentation Correctness was Re: How many levels of indents and heads are reasonable? From:Richard Lewis <tech44writer -at- yahoo -dot- com> To:John Posada <jposada01 -at- yahoo -dot- com> Date:Thu, 18 Oct 2007 13:43:55 -0700 (PDT)
For task/functional analysis, only the activity diagram and use cases come into play. Data and state modeling is something else. The key interrelationships, as far as task analysis is concerned, are data flows - not any other interrelationship other than data flows. Neither use cases nor activity diagrams capture data flows.
I deal with the tragic flaw of the UML (i.e., nothing that focuses on the flow of data) all the time. Developers model parts of a system but are not able to perform larger scale integration. That is because use cases and activity diagrams derail the task/function discovery process.
Generic Richard
John Posada <jposada01 -at- yahoo -dot- com> wrote:
I'm talking about any one of the the 13 UML diagram types. EVERY type
of diagram examines the relationship between two entities; each form
examines it in a different way. To me, that's pretty rigorous.
One, class digrams, by definition, includes dependency, multiplicity,
association, and aggregation.
You also have the association notations which describe direction,
relationship, etc. These attributes define how data moves through a
system.
Is this not "rigorously identifying the interrelationships between
tasks"?
--- Richard Lewis wrote:
> By UML I assume you mean Use Cases and/or Activity Diagrams.
> (Those are the two functional modeling techniques within the UML.)
>
> The interrelationships are most often data flows. Only data flow
> diagrams capture the data flows.
John Posada
Senior Technical Writer
"They say everyone needs goals. Mine is to live forever.
So far, so good."
__________________________________________________
Do You Yahoo!?
Tired of spam? Yahoo! Mail has the best spam protection around http://mail.yahoo.com
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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-