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.
You have been asked to perform a very rigorous systems analysis. The
reason you did not find much in the archives is that very few technical
writers do this type of work. Indeed, most systems analysts go there
entire career without doing significant data dictionary work.
I recently created a data dictionary. The major task is to create very
clear and concise data flow diagrams and entity relationship diagrams.
The data dictionary rigorously defines the business terms used in these
If the software system is more function intensive (such as a inventory
control or accounting system) you will need to make heavy use of data
flow diagrams. If the software is more of a decision support system
(such as a database system that primarily serves to process user ad-hoc
queries) you will need to make extensive use of entity relationship
diagrams. Often you will need to utilize both techniques.
I myself favor data flow diagrams (maybe because the systems that I have
worked on are more function intensive). If I need to create entity
relationship diagrams, data flow diagrams are often my primary input.
KEY POINT: The primary purpose of a data dictionary is to define WHAT
the individual entries mean from a business perspective. They may also
define HOW each entry is to be implemented - such as format and data
type. But be aware that 98% of the required work is in nailing down the
Much of what I have stated above you can find in any college level text
on structured systems analysis and design (although I have slanted it
towards my experience "in the trenches"). The all-time classic is Tom
DeMarco's book (Yourdon press about 1975).
(tonymar -at- hotmail -dot- com)
>From techwr-l -at- listserv -dot- okstate -dot- edu Fri Apr 3 14:13:21 1998
>Received: from listserv (220.127.116.11) by listserv.okstate.edu (LSMTP
for Windows NT v1.1a) with SMTP id <0 -dot- 6B50E020 -at- listserv -dot- okstate -dot- edu>;
Fri, 3 Apr 1998 16:13:20 -0600
>Date: Fri, 3 Apr 1998 14:10:12 PST
>Reply-To: Michelle Nolan <nolanmj -at- HOTMAIL -dot- COM>
>Sender: "Technical Writers List; for all Technical Communication
> <TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU>
>From: Michelle Nolan <nolanmj -at- HOTMAIL -dot- COM>
>Subject: Data Dictionary
>To: TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU
>I have been asked to write a data dictionary for an Oracle database,
>which uses MS Access as its front end application. I?ve never done
>before, and would appreciate any and all advice on data dictionaries
>(what is included, how to construct, etc.). What is involved and how
>can I come up to speed in a very short period of time?
>I have searched the archives, and while I have found a few articles
>mention DDs, I didn?t come up with any specifics.
>Thanks so much-
>Get Your Private, Free Email at http://www.hotmail.com
>Find TECHWR-L-related books at http://www.raycomm.com/techwhirl/books.htm