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.
> But the description of some of the fields is quite obvious
Yes fields can have obvious fields like Name. But, if you take the time to
add the context information you can add value to obvious things. In our
systems, fields are used in queries. Name can be the name of the object, the
parent, the child, the referent, the collection, or the trustees. It needs
to be more obvious.
You have run into the same situations with dialogs. They can appear obvious
as well. But, here again, considering the context of that dialog means that
there should be a chain of links relating to how the dialog was opened, what
relationships it may have with other dialogs in the UI, what views in the
user's conceptual model the dialog is related to, and what objects in the
user's conceptual model are related to those views.
The term for obvious around here is "User Boy." I really can't stand that
term. And, it is the TWs that run around using it as an excuse not to
contextualize their content.
Even if the node is obvious, the links, associations, and relationships are