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.
<snip>
To be effective, a data dictionary should incorporate some of the
features of a data flow diagram: it should indicate what programs /
functions create, change, or use each of the data elements. Otherwise,
spot on.
Matt Danda wrote:
>
> Michelle:
> In my experience, a data dictionary is simply a table describing
> fields. For example, one data dictionary I use only has the columns:
> Field Name, Length, Type, and Description.
</snip>
What Michael describes is an entity-relationship or object-relationship
diagram. What Matt describes is a data dictionary. For the latter, I prefer
the Yourdon method, which looks like this:
Key:
= is composed of
+ and
( ) optional (may be present or absent)
{ } iteration
[ ] select one of several alternative choices
| separates alternative choices in the [ ] construct
* * comment
@ identifier (key field) for a store
Data element Description
employee_record = @employee_id + employee_name + employee_title
+ manager_id + ( [ {child} ) | {pet} ] )
* do not use this
element for contract employees*
John_F_Renish -at- notes -dot- seagate -dot- com, San Jose, California, USA
My remarks do not represent any other person or entity
