Introduction
ClearQuest documentation comes in many forms. These include PDF user and administration guides for versions prior to v7.0.0, Installation guides, and online resources such as the IBM Developerworks ClearQuest Forum, technotes etc. Don't forget about the online help in the application. This page lists some suggestions on how to locate these resources.
PDF User Guides
Version 2003.06.00+
The following documentation can be found on your hard drive in the directory where you install the ClearQuest application. Typically this directory is located:
C:\Program Files\Rational\ClearQuest\doc\books
| Filename |
Purpose |
| cqms_admin.pdf |
ClearQuest Multisite Administration provides information on how to administer ClearQuest specifically Multi-Site |
| cq_admin.pdf |
ClearQuest Administration provides information on how to administer ClearQuest |
| cq_api.pdf |
API Guide provides information on how to script hooks and external scripts to access the ClearQuest Database |
| cq_intro.pdf |
Introduction to ClearQuest provides basic description of ClearQuest and it's functions |
| cq_relnotes.pdf |
Release notes for ClearQuest |
| cq_tracker.pdf |
Project tracker documentation for integration with Microsoft Project 2000 |
Version 7.0.0+
In addition the version 7 tools include these documents in the same location
| Filename |
Purpose |
| cq_ms_admin.pdf |
ClearQuest Multisite Administration provides information on how to administer ClearQuest specifically Multi-Site |
| cq_ms_install.pdf |
Installation information for ClearQuest Multi-Site |
Installation Media
You will find install guides located <drive>:\doc\books on your installation media. You can also find this information downloadable from the Passport Advantage e-care site where you download installation media.
On-line Resources
A number of documentation resources are available on line. For releases 7.0.0 and later much of the documentation that was previously released in PDF form is now only available through on-line resources.
ClearQuest Info Center online help
This site has all the information you would expect to find in PDF form for version 7.0.0+ (on installation for previous releases). It should be one of your first stops in the search for documentation.
http://publib.boulder.ibm.com/infocenter/cqhelp/v7r0m1/index.jsp
Application Help
Much of the application documentation is available through the Help menu item in your ClearQuest applications. Links there will connect you with other on-line resources.
On-Line Communities/Forums
http://www.ibm.com/developerworks/wikis/display/cm/ClearQuest
ClearQuest WIKI (this wiki).
http://www.ibm.com/developerworks/forums/forum.jspa?forumID=329
This is the IBM ClearQuest developerworks forum. This community can be helpful for finding answers to issues and help with various hook, scripting issues relative to the ClearQuest Developer environment.
http://www.cmcrossroads.com
Forums, articles and other information about configuration management. Not IBM Rational specific. See the Software Development/ClearQuest forum section.
See Also
ftp://ftp.software.ibm.com/software/rational/docs
Contains a list of various Rational documentation. This is a higher level folder than the next two sites listed.
ftp://ftp.software.ibm.com/software/rational/docs/v2003/win_solutions/autorun.htm
A list of documentation available for various Rational tools version 2003.06.00.
ftp://ftp.software.ibm.com/software/rational/docs/v2003/unix_solutions/pdf/
A list of pdf documents that pertain to the rational tools on Unix 2003.06.00.
http://www-128.ibm.com/developerworks/rational/library/4236.html
ClearQuest Hooks index - Contains sample code in perl and VB for customization of ClearQuest and accessing the ClearQuest database via the ClearQuest API.
http://www-1.ibm.com/support/docview.wss?uid=swg21146727
ClearQuest e-mail notification how to for perl.
http://www-1.ibm.com/support/docview.wss?uid=swg21216371
ClearQuest and Crystal Reports supported version information.
http://www-1.ibm.com/support/docview.wss?uid=swg21261360
How to
Configure anti-virus software for ClearQuest e-mail notifications.
http://www-1.ibm.com/support/docview.wss?uid=swg21231445
Mustgather - tool for diagnosing e-mail issues with ClearQuest.
http://www-130.ibm.com/developerworks/rational/community/
A starting page for various resources for Rational Tools. From here you can get to the forum, user group community, e-zines, webcasts, blogs and other resources.