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.
Subject:Yet another new thing From:Keith Hood <klhra -at- yahoo -dot- com> To:techwr-l -at- lists -dot- techwr-l -dot- com Date:Sat, 28 Apr 2007 17:05:38 -0700 (PDT)
This new job of mine is just chock full of surprises.
Now the chief system architect says that included with
the other documentation, we wants a data point map. I
had never heard of such a thing before. He wants a
document - no definite form, apparently - that shows
where each point of data in the database is used in
every other part of the system.
(Most of the finished system will be done in Java, but
parts will be in C++.)
For instance, suppose you have a data table named
"ShouldI" and in that table is a field named "RunAway"
with a value of "HellYes." He wants something that
shows every method in every class in the entire system
where the "ShouldI > RunAway: HellYes" data point is
used in any way. Just doing a text search and listing
the files isn't good enough; he wants a layout on
paper (Visio tree diagram, outline in a Word document,
some form) that goes practically down to the line
number in each file. He tells me this is something
entirely different from ERDs or UML diagrams.
I've never before heard of a data point map, and while
I've started searching for info on the Web, I would
appreciate any pointers anyone has on how to do such a
thing. Any suggestions on tools for doing this?
I figure that code comments could be excluded from the
areas searched for data points. Since a comment
doesn't really use the data point, it's not relevant
whether you include that location in the map. Does
that sound right?
__________________________________________________
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
Now shipping: Help & Manual 4 with RoboHelp(r) import! New editor,
full Unicode support. Create help files, web-based help and PDF in up
to 106 languages with Help & Manual: http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-