Bug 780665 (SOA-3104) - Please consider including a glossary for our documentation
Summary: Please consider including a glossary for our documentation
Keywords:
Status: CLOSED NOTABUG
Alias: SOA-3104
Product: JBoss Enterprise SOA Platform 5
Classification: JBoss
Component: Documentation
Version: 5.1.0 GA
Hardware: Unspecified
OS: Unspecified
medium
medium
Target Milestone: ---
: ---
Assignee: Default User
QA Contact:
URL: http://jira.jboss.org/jira/browse/SOA...
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2011-06-13 13:02 UTC by Rick Wagner
Modified: 2011-06-13 22:48 UTC (History)
0 users

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Any SOA-P
Last Closed: 2011-06-13 22:48:55 UTC
Type: Feature Request


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Red Hat Issue Tracker SOA-3104 0 None None None Never

Description Rick Wagner 2011-06-13 13:02:42 UTC
Affects: Documentation (Ref Guide, User Guide, etc.)
project_key: SOA

I've realized our documentation is inferior to third party resources (i.e. 'JBoss in Action', 'JBoss at Work', etc.) in an important aspect.  Third party books provide a glossary at the end of the document that can be used to look up a topic of interest.  (i.e. 'transaction', 'connection factory', etc.)  Our documentation has no such index, the user has to open each of the documents individually and use a search feature to locate topic references.

This is not as handy, because the user has no way of knowing how many references they'll need to page through, and is unable to quickly jump to the desired one.  If a glossary is present, often times the user can judge which instance to use based on proximity to other instances.  (i.e. a single lone instance on page 16 is probably a high-level introduction, but if you see a cluster on pages 456, 458 and 459 you know the topic is being discussed in detail there.)

Please consider providing a glossary in our documentation.

Thanks!

Comment 2 David Le Sage 2011-06-13 22:48:55 UTC
Release Notes Docs Status: Added: Not Required



Note You need to log in before you can comment on or make changes to this bug.