[
https://issues.apache.org/jira/browse/DERBY-1920?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12463981
]
Kim Haase commented on DERBY-1920:
----------------------------------
I found another file that needs a title change. (This will get lost if I just
add it to a revised list.) It's ref/rrefjdbc32593.dita, "JDBC 3.0-only
features". The problem is that these features actually apply to 3.0 and later
releases (i.e. to 4.0 also).
Similarly, adding a file named "JDBC 2.0-only features" won't do. So instead
I'm changing ref/rrefjdbc32593.dita to "JDBC 3.0 features", and the new one for
2.0 is called "JDBC 2.0 features".
The title for the 4.0 summary can stay "JDBC 4.0-only features" because that's
currently true -- but we'll need to change it if/when JDBC 5.0 comes along.
Please let me know if you can think of a better solution. Would "Features new
at JDBC x.0" or "Features added at JDBC x.0" be better?
> 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
