Mailing-List: contact derby-dev-help@db.apache.org; run by ezmlm
Precedence: bulk
Reply-To: <derby-dev@db.apache.org>
Message-ID: <18405220.1168099767708.JavaMail.jira@brutus>
Date: Sat, 6 Jan 2007 08:09:27 -0800 (PST)
From: "Kim Haase (JIRA)" <jira@apache.org>
To: derby-dev@db.apache.org
Subject: [jira] Commented: (DERBY-1920) DOCS - Improve topic titles for
 vague and duplicate topics
In-Reply-To: <31595555.1159902261829.JavaMail.root@brutus>
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: 7bit


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

Kim Haase commented on DERBY-1920:
----------------------------------

I've added a revised list that incorporates your comments, Laura (to the extent we resolved the issues, I think) and also reflects the reordering that you did for DERBY-2013. I made headers for the different sections of the Reference Manual to make the list easier to navigate. I'll get started on this now. More comments and suggestions are welcome!

> DOCS - Improve topic titles for vague and duplicate topics
> ----------------------------------------------------------
>
>                 Key: DERBY-1920
>                 URL: https://issues.apache.org/jira/browse/DERBY-1920
>             Project: Derby
>          Issue Type: Bug
>          Components: Documentation
>    Affects Versions: 10.2.1.6
>            Reporter: Laura Stewart
>         Assigned To: Kim Haase
>             Fix For: 10.2.3.0, 10.3.0.0
>
>         Attachments: DERBY-1920.list, DERBY-1920.list-2.txt, DERBY-1920_list_ls.htm
>
>
> 1) Many of the topic titles are vague. 
> Examples - 
> a) Almost all of the titles for the built-in function topics do not indicate that the topic is about a "function".
> The word "function" should be added to all of the reference topics (In the Reference Manual) that discuss the built in functions
> b) Almost all of the titles for the data type topics do not indicate that the topic is about a data type.
> The words "data type" should be added to all of the reference topics (In the Reference Manual) that discuss the data types
> c) Some of the SQL statement topic titles do not include the word "statement" in the title and they should.
> 2)Some of the topics use the same title, but discuss very different things.  Each topic title in the Derby documentation should be
> unique.  
> Examples - 
> LOCK TABLE statement in the Reference Manual (http://db.apache.org/derby/docs/dev/ref/rrefsqlj40506.html)
> and in the Tuning Guide (http://db.apache.org/derby/docs/dev/tuning/ctunoptimz11775.html)
> This is just one of several examples.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: https://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira