By techdogg on Apr 27, 2007
As a writer for Sun Cluster software, I am constantly looking up information in various manuals and man pages on docs.sun.com to check facts and provide references. I've learned a few ways to help speed up my information search.
Use Browse Product Documentation to search a whole documentation set
The default docs.sun.com search choices are to search all titles in docs.sun.com or to search within a book or collection that is already displayed. But there is also a way to search within a specific documentation set or product line.
Say you are looking for information about HAStoragePlus. You found it once before in a Sun Cluster 3.2 document, but you can't remember which document that was. Was it in a data-service book, a man page, the system administration guide? Since you know the product and release you want to search in, go to the Browse Production Documentation tab of docs.sun.com. From here you can search all collections that belong to the Sun Cluster 3.2 release, but ignore everything else.
To display the entire Sun Cluster 3.2 documentation set, drill down to Software > Enterprise Computing > High Availability/Clustering > Solaris Cluster > Solaris Cluster 3.2. You'll see "Solaris Cluster 3.2" in the Within search field. From here, in a single search you can look for "HAStoragePlus" throughout the Sun Cluster 3.2 hardware, software, data service, man page, release notes, and Geographic Edition collections.
3.2 products (framework, data services, and Geographic Edition) are being marketed under the name of Solaris Cluster, similar to their being marketed under the name of Sun Java Availability Suite. It's all the same thing.
Use the Index when a word you search for isn't found
Although "One Term, One Meaning" is an ideal that technical writers aspire to, features can end up being called different names by different groups when a product is finally released. So the feature name you are used to using during development or Beta might not be the formal name used in the final product documentation. A look in the index of a book that is likely to document the feature could help you find the formal name of the feature you want to read about.
For example, a file system that is configured with HAStoragePlus is informally referred to as a "failover file system". A search for that term in the Sun Cluster 3.2 doc set finds hits in two books. Follow the hit in the Software Installation Guide to the index, and there you will see "failover file system, See highly available local file system". Run your search again on "highly available local file system", and you will get several hits instead of two.
Looking up a familiar term can also be helpful by showing you other possible index terms to look under. For example, the index listing for "installing" might include "See also adding" and "See also configuring". You can look up these additional terms if you don't quite find what you are looking for under "installing".
Use the Documentation Center for quick links to frequent topics
The Documentation Center is a new reference tool in Sun Cluster 3.2. This web page provides links to information at different levels of the documentation, grouped by topic or purpose. If there is an important feature you want to look up, you can probably find a link to it in the Sun Cluster 3.2 Documentation Center.
Use an external search engine
If you prefer, you can use an external search engine to locate information on docs.sun.com. Include "site:docs.sun.com" in your search criteria, and the search will be conducted only on docs.sun.com documents. Also include "Sun Cluster 3.2" and the search will hit mostly or only documents in the Sun Cluster 3.2 doc set.
Restore missing bullets
This is a readability tip rather than a search tip. A lot of Sun Cluster documentation uses bulleted lists to organize information and make it easier to read or scan. But sometimes on my browser the bullets don't display, leaving me with indented paragraphs that are hard to read. If that happens to you, just press Shift-Reload and the bullets should show up.
Learn how the docs.sun.com search works
The search syntax that docs.sun.com uses is very different from most search engines, especially how it interprets special characters. To avoid frustration, click the Search tips link, just under the search field on any docs.sun.com page, and read about how docs.sun.com works.
Tell us what you want
There is a Send comments link on the same line and to the right of the Search tips link, on any docs.sun.com page. This takes you to a feedback site for both documentation content and website functionality. If you are reporting an error in a book, or like something and want to see more of it, include the URL or the book and section title that you are talking about. Unfortunately, the Send comments site is not aware of what web page you are in when you click the link, so you have to provide that information in the Comments field.
I hope these tips help you find more quickly and easily the Sun Cluster 3.2 information you need.
Sun Cluster Technical Publications
"We're the M in RTFM"