db-derby-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Kim Haase (JIRA)" <j...@apache.org>
Subject [jira] Commented: (DERBY-2390) DOCS - Merge Working with Derby and Getting Started Guide
Date Tue, 13 Mar 2007 15:40:09 GMT

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

Kim Haase commented on DERBY-2390:
----------------------------------

Excellent start on this, Laura! 

cgsintro.html looks just fine. Good catch on the title issue.

On rgsdocs17307.html -- just a few things:

I'm glad you caught the problem with the term "library. I don't think Derby is technically
a product, which implies something that is sold; so maybe just "Derby documentation" would
be a better title.

The new description of the Getting Started guide might be split into two or more sentences
-- it's kind of a long list of topics. The Developer's Guide description might also be split
into two sentences. The others are fine.

"Javadoc," believe it or not, is actually a Sun trademarked term that applies to the tool
used to generate API documentation. Derby doc isn't Sun doc, so it doesn't really have to
obey the trademark requirements, and "javadoc" is in extremely common use as a noun. But it
might be nice to use the term "API documentation" or "API reference" instead of "javadoc."



> 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
>         Attachments: cgsintro.html, rgsdocs17307.html
>
>
> 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