[
https://issues.apache.org/jira/browse/DERBY-1920?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12476800
]
Laura Stewart commented on DERBY-1920:
--------------------------------------
For the cdevstandards files...
Sigh. Whoever set up this file is using the parent/child relationships in the
ditamap to display the topic shortdesc in the main
"Derby and standards" topic. My recommendation is that all of the content in
these separate files (except the last one) be moved to the main
topic as a formal bulleted list. For the last topic, keep it as a separate
topic and keep the parent/child relationship in the ditamap (so that there is a
link), since it is a long topic.
But this is far more work than just changing topic titles :-(
So I suggest that you skip these topics in Dev Guide for Derby1920 and open a
new issue for this problem. Then anyone can make this correction.
But if you want to do it now ... up to you :-)
> 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-adminguide.diff, DERBY-1920-adminguide.zip,
> DERBY-1920-devguide.diff, DERBY-1920-devguide.zip, DERBY-1920-tuning.diff,
> DERBY-1920-tuning.zip, DERBY-1920.list, DERBY-1920.list-2.txt,
> DERBY-1920.list-3.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.
-
You can reply to this email to add a comment to the issue online.
