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.
The Oracle site should also have documentation for Oracle Applications,
which are specific front ends to Oracle dbs.
For most users, the database schemas aren't as important as the UI.
Maybe you could follow the MVC approach, which engineers use to organize
applications themselves. MVC stands for Model-View-Controller. The model
is the underlying data, the View is the UI, and the Controller is the
logic that links everything together.
For example, if I develop a simple personnel app, then the Model is the
employee tables, the View is Change/Review/Update/Delete (makes a
wonderful acronym) screens, and the Controller is the logic that
prevents you, say, from adding a person who's already in the database.
This is way simplified. The Model itself may include constraints,
triggers, etc. The View may contain persistent data from one page to the
next. You might consider the action buttons, etc. as part of the
Controller.
Engineers and sysadmins might want a reference and a programming guide
that tells them how to do backups, etc. and how to write programs that
access the data.
Joe
Joe Malin
Technical Writer
(408)625-1623
jmalin -at- tuvox -dot- com
www.tuvox.com
The views expressed in this document are those of the sender, and do not
necessarily reflect those of TuVox, Inc.
-----Original Message-----
From: Jennifer C. Bennett [mailto:fritillary -at- gmail -dot- com]
Sent: Thursday, September 08, 2005 12:55 PM
To: Joe Malin; TECHWR-L
Subject: Re: Online Examples of Good Database Documentation
Well, I am documenting a database for an application. Describing the
purpose of each table, and each column within those tables, and how
those tables and columns interact with the web application front end..
The following sections make up the "meat" of the document:
* "Normal" user screens: How to use the application.
* "Administrator" screens: How to administer the application
Now Shipping -- WebWorks ePublisher Pro for Word! Easily create online
Help. And online anything else. Redesigned interface with a new
project-based workflow. Try it today! http://www.webworks.com/techwr-l
Doc-To-Help 2005 converts RoboHelp files with one click. Author with Word or any HTML editor. Visit our site to see a conversion demo movie and learn more. http://www.componentone.com/TECHWRL/DocToHelp2005
---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit http://www.techwr-l.com/techwhirl/ for more resources and info.
