Home | Contact Us | FAQ | Search & Site Map | Link to Us
Sign In | Join | Other 45 Sites in Network
HomeAnnouncementsWhite Papers
Discussion GroupsFirst AidDatabasesJavaBeansGUIJava 3DVirtual MachineCORBASecurityToolsGeneral
Java DirectoryOpen Source ProjectsSample Book ChaptersUser GroupsWeb Resources
Related Topics
Databases.NETMore Topics ...

Java Forum / Databases / June 2004

Tip: Looking for answers? Try searching our database.

Documentation

Thread view: 
Roedy Green - 20 Jun 2004 03:30 GMT
I am rather amazed at the quality of documentation of MySQL and
HSQLDB. I would think given the extreme competition in this area, that
the documentation on the popular databases would be first class.

Yet it is abominable.  You could easily waste 2 days just getting
HelloWorld to work.

You need two kinds of documentation:

1. getting started. Which leads you step by step through a simple
project, such as HelloWorld.

2. reference docs.

The most popular model of documentation seems to be the FAQ where the
questions surely cannot be Frequent given how esoteric they are and
there is no order, just a giant heap.  Every triviality is treated
identically to the set of 10 questions every newbie must answer to be
able to even get started.

The readme file never tells you where to get started. They just talk
about changes to the products internals which is of no interest to a
first time user and of little interest to anyone else.

Most of the reference documentation is irrelevant to most of the
users. There needs to be a way of classifying facts by how important
they are, and providing some sort of automatic filtering to avoid
overwhelming the reader with stuff he already knows, or with stuff
that is unlikely to be useful.

I suggest how to proceed at http://mindprod.com/jgloss/author.html

Signature

Canadian Mind Products, Roedy Green.
Coaching, problem solving, economical contract programming.
See http://mindprod.com/jgloss/jgloss.html for The Java Glossary.

David Harper - 20 Jun 2004 05:13 GMT
> I am rather amazed at the quality of documentation of MySQL and
> HSQLDB. I would think given the extreme competition in this area, that
> the documentation on the popular databases would be first class.
>
> Yet it is abominable.  You could easily waste 2 days just getting
> HelloWorld to work.

I can't comment on HSQLDB, but I've always found the MySQL online manual
to be excellent. I have no trouble homing in on the information that I need.

> You need two kinds of documentation:
>
> 1. getting started. Which leads you step by step through a simple
> project, such as HelloWorld.
>
> 2. reference docs.

The online MySQL documentation is clearly labelled "MySQL Reference
Manual" so it obviously falls into category #2. It's not meant to be a
tutorial.

If you're looking for something in category #1 for MySQL, there are
plenty of books on the market. Personally, I find Paul Dubois' book
"MySQL" to be an admirably clear introduction to MySQL and to database
programming in general. Okay, so you have to part with hard cash for it,
but hey, you got the darn database for free, didn't you? :-)

David Harper
Cambridge, England


Free Magazines

Get these publications absolutely FREE for up to 12 months. There are no hidden fees and no obligation. Simply choose a title, complete the application form and submit it. Read more ...

Oracle MagazineNetwork ComputingComputer WorldBio-IT WorldeWeekInformation WeekInfosecurity
 
Sign In
Join
My Latest Posts
My Monitored Threads
My Blog
My Photo Gallery
My Profile
My Homepage

Start New Thread
Enable EMail Alerts
Rate this Thread



©2009 Advenet LLC   Privacy Policy - Terms of Use
This website includes both content owned or controlled by Advenet as well as content owned or controlled by third parties.