Good afternoon. One of my upcoming projects is to provide database documentation for our new developers as we begin to create the new database. Right now, the project manager is using Embarcadero Web Report, which shows the hierarchical structure of the database. For instance, under Logical is Main Model, and under that is Entities, Attributes, and Keys. You can then view specific attributes, etc. (By the way, I think we're going to use MySQL-or some variant of SQL, if that helps.)
So that's my raw information-a report that changes as needed that provides database information in tables. What my project manager wants is on-line documentation (I already have a HAT, so please no suggestions on software) that I or team members (using team authoring and VSS, of course) update as necessary. This is my first time documenting database development, so I really don't know where to begin in providing useful information to our developers (who, by the way, won't be coming in until Q1 of '07). If anyone here has had any experience doing this, I'd like to hear what you did-the format, information types, etc-and what helped your developers the most. Have a good vacation weekend (bland and inoffensive closing) RGBrasel ______________________________________________ Author Help files and create printed documentation with Doc-To-Help. New release adds Team Authoring Support, enhanced Web-based help technology and PDF output. Learn more at www.doctohelp.com/tcp. Are you a Help Authoring Trainer or Consultant? Let clients find you at www.HAT.Matrix.com, the searchable HAT database based on Char James-Tanny's HAT Comparison Matrix. Contact [EMAIL PROTECTED] for details. _______________________________________________ Technical Communication Professionals Post a message to the list: email [EMAIL PROTECTED] Subscribe, unsubscribe, archives, account options, list info: http://techcommpros.com/mailman/listinfo/tcp_techcommpros.com Subscribe (email): send a blank message to [EMAIL PROTECTED] Unsubscribe (email): send a blank message to [EMAIL PROTECTED] Need help? Contact [EMAIL PROTECTED] Get the TCP whole experience! http://www.techcommpros.com
