db-derby-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Laura Stewart (JIRA)" <j...@apache.org>
Subject [jira] Commented: (DERBY-2390) DOCS - Merge Working with Derby and Getting Started Guide
Date Mon, 05 Mar 2007 20:40:50 GMT

    [ https://issues.apache.org/jira/browse/DERBY-2390?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12478150
] 

Laura Stewart commented on DERBY-2390:
--------------------------------------


There seems to be some overlap between the Getting Started info and
the Derby Tutorial (install Derby, set classpath, etc).  Also some
overlap between the Working with Derby Guide and the Derby tutorial
(embedded vs Network server).

Is there a reason why there is this duplication?

We should strive to have the info documented in one place, either the
books or the Web, but typically not both.  The main reason for this is
maintenance.  Writers like to single source the documentation so that
it is easier to maintain.  By having this info in 2 places (2 source
files) we run the risk of one or the other being out of date.

I do see some information that is not in the books, particularly the
info on working with other products.  There might be other examples as
well...

One way to avoid the duplication, is to point the reader to the main
place for info.  For example, instead of providing the installation
info on the Web, indicate that installation is a step and point the
reader to the Getting Started Guide, installation section.

As for having "Apache" in the titles, that makes perfect sense to me.
It should be there.

-- 
Laura Stewart


> DOCS - Merge Working with Derby and Getting Started Guide
> ---------------------------------------------------------
>
>                 Key: DERBY-2390
>                 URL: https://issues.apache.org/jira/browse/DERBY-2390
>             Project: Derby
>          Issue Type: Improvement
>          Components: Documentation
>            Reporter: Laura Stewart
>         Assigned To: Laura Stewart
>
> The activities in the Working with Derby guide should be merged into the Getting Started
Guide.
> Review Getting Started Guide for any reference info that should be either "shared" with
another guide
> or moved to another guide. For example, the SQL Syntax section in the Getting Started
Guide should 
> be moved to the Reference Manual.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


Mime
View raw message