Bug 780665 (SOA-3104)

Summary: Please consider including a glossary for our documentation
Product: [JBoss] JBoss Enterprise SOA Platform 5 Reporter: Rick Wagner <rwagner>
Component: DocumentationAssignee: Default User <jbpapp-maint>
Status: CLOSED NOTABUG QA Contact:
Severity: medium Docs Contact:
Priority: medium    
Version: 5.1.0 GA   
Target Milestone: ---   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
URL: http://jira.jboss.org/jira/browse/SOA-3104
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Any SOA-P
Last Closed: 2011-06-13 22:48:55 UTC Type: Feature Request
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:

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