FAQs and additional resources


Writer: This page offers hyperlinks to additional information for your product (both BMC sites as well as external sites, if applicable) and also contains FAQs for the product.

This topic provides information that supplements the productName VV.RR documentation. It contains the following sections:

Additional resources from BMC

Writer: Use this section to offer hyperlinks to related information that does not reside in this space. This page is where you help users tie together different BMC repositories and organizations such as Communities, Education, and Global Services. You might also include hyperlinks to documentation for a product that users are likely to use with your product. 

If the following productName resources exist for your product release, you must include hyperlinks to them. This page uses BMC Cloud Lifecycle Management hyperlinks as examples, but you should replace them with your own. You might have more or fewer than these. If you have a large number of hyperlinks, split them into categories under h2 headings to make the page easier to scan.

To find the right URL for the KB search:

  1. Go to this KB page.
  2. In the Products list in the left pane, select your product name.
  3. Copy the URL in your browser's address field.
  4. Delete the &searchID= string at the end of the URL, starting with the ampersand.
    For example, &searchid=1330545189498

The following BMC sites provide information outside of the productName VV.RR documentation that you might find helpful:

Frequently asked questions

Writer: Follow the instructions in Developing-FAQ-lists to develop this topic.

This section provides answers to frequently asked questions (FAQs) about productName.

Writer: Include the following FAQs in your list. You will need to modify the content of the FAQ so that it applies to your product, replacing all links with appropriate ones for your space.

What happened to all the PDFs for this product?

Writer: List the titles of documents from your last non-wiki release at a minimum, and consider including earlier documents if they were popular with users or if many customers have not yet upgraded from an earlier release. In the titles for these documents, omit leading product names and any version numbers to make the table easier to scan.

In the right column of the document tables, map each document to your space by linking to each branch that contains a significant amount of content from the document. Keep the table manageable by using parent links instead of linking to multiple children. Group links under their top-level parent.

For a large space, you might need to link to lower-level topics than in these examples, especially when parts of multiple guides end up in the parent branch. For example, several guides might have had a separate install chapter. Link to whatever topic level is appropriate for your content.

Where to find information previously provided in a guide or manual

Document title

Found here in

Installation Guide

Configuration Guide

Key concepts
End-to-end process
User roles

Configuring after installation
Topics...

Administering
Topics...

 

 

 

 

 

 

Where do I find release note information?

The following table describes where you can find information previously provided in release notes.

Type of information

Found here in

New features (enhancements) and other information

  • Issues corrected by the base release and its service packs and patches
  • Issues that are currently open
Where can I find technical bulletins?

Technical bulletins contained information delivered after a product was released, often in conjunction with a service pack or patch for that release.

Where to find information previously provided in a technical bulletin

Type of technical bulletin

Found here in

Contents of a service pack or patch and instructions particular to it

  • The child topic for that service pack or patch under What's new
  • For issues corrected in the service pack or patch, sort the table in Known-and-corrected-issues by the "Corrected in" column

Other information

Placed in context throughout this space, but listed and linked to in Documentation updates

Where do I find information previously provided in a white paper?

Writer: List the titles of any white papers from your last non-wiki release. In the titles for these documents, omit leading product names and any version numbers to make the table easier to scan.

In the right column of the document tables, map each white paper to your space by linking to each branch that contains a significant amount of content from the white paper. Keep the table manageable by using parent links instead of linking to multiple children. Group links under their top-level parent.

The following table shows how to locate the information previously provided in a white paper.

Document title

Found here in

 

 

 

 

 

 

Where do I find information that was previously published as a flash bulletin?

Flashes contained urgent information about product issues and are delivered after a product is released. On docs.bmc.com this information is delivered in an "Urgent issues" topic, under What's new. If this topic does not exist for a given product release, no urgent issues have been discovered for that release.

Is all the content for productName versionNumber in this space?

Writer: Include the following paragraph and list if the documentation for your release spans more than one space. Hyperlink each space name to its space.

The documentation for productName versionNumber is split between multiple spaces, so a space-level search performed in the box in the left navigation pane does not search all the documentation for this release. The following spaces document this release:

  • spaceName1description1
  • spaceName2description2
  • spaceName3description3
I’d like a PDF of just selected information. How can I do that?

The BMC Documentation portal gives you the ability to generate PDF exports of multiple pages in a space. 

Creating PDF exports

You can create a PDF of a page or a set of pages. (Non-English page exports are not supported.) You can also create a Word document of the current page.

To export to PDF

  1. Click the Export icon in the upper-right. 1744830844926-963.png
  2. From the Export menu, select PDF.
  3. Follow the prompts for page selection and other options.
  4. Click Export.
 

Depending on the number of topics included in the export, it might take several minutes to create the PDF. Once the export is complete, you can download the PDF.

Other useful sites

The following sites also provide information that you might find helpful:

Writer: Include this section only if you have hyperlinks to external sites such as a product user group. If you have more than one reference, provide the hyperlinks and descriptions in a bulleted list. If you have a single reference, revise the introductory sentence to be grammatically correct (singular noun and verb), and then provide the hyperlink and description under the introduction as a paragraph.

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*