IBM Support

Support: How to suggest a technical note

How To


Summary

This article explains how you can suggest a support technical note by using the 101 sites. It also covers what makes for a good suggestion and how suggestions are handled.

Steps

How to suggest a support technical note
To suggest feedback, open the home page of the 101 site for the product you would like to suggest an article for and click the Give Feedback tool.
feedback
Then, select Suggest Content and add your suggestion. See the next section for tips on what makes a good suggestion.
suggestion
What makes a good suggestion?
When suggesting a support technical note, include all the relevant details our writer needs to get started such as:
  • The clearly stated goal or question
  • Environment details such as your software version, appliances, or relevant installed apps
  • Specific error messages, and where they appeared in the UI or what command triggered them in the CLI
  • Tell us if you have a related case, but do not include the case number
  • If you have any notes on the solution, include them.
Examples of good suggestions:
After running "/media/updates/installer" in the CLI to upgrade my QRadar console to 7.5.0, I got the error "System is not fully configured with QRadar. Please ensure QRadar is fully installed and configured." I was able to solve this problem by creating the /opt/qradar/conf/.configdone file and trying again. There should be a technical note documenting this. It could also explain the origin of this error.
How can I change the WinCollect 10 base path? I want to change the WinCollect configuration console data directory from the default at /%ALLUSERSPROFILE%/WinCollect/Data/Events to something custom. Is that possible, and if so, how?
Do not include:
  • Sensitive information such as IP addresses
  • Case numbers
  • Contact information or other identifying details
Not all suggestions can result in a published support technical note. We cannot write articles on unsupported features or versions of software. You can read more about the QRadar software support lifecycle here. See the QRadar 101 Support Policy page to learn about what is considered is In-Scope and Out-of-Scope.
You can read more about the CP4S software support lifecycle here. See the CP4S 101 Support Policy page to learn about what is considered is In-Scope and Out-of-Scope, and keep in mind that some support topics can fall under Red Hat support.
How are suggestions handled?
When the content team is notified of a new suggestion, we first triage the idea by determining whether it is In-Scope and not covered by other documentation. If the suggestion is related to another published article, we can update the original with the new information. After we confirm the idea is appropriate to write, we add it to our ideas queue and work to publish the content in a timely manner. Because we do not collect personal information from user suggestions, we cannot follow up with users after the suggested article is published.  The best way to be notified of new support technical notes is to sign up for IBM My Notifications.
Feedback on existing technical notes and APARS
For feedback on existing technical notes and APARs, use the Share your feedback tool on the IBM Support page for that article.

Document Location

Worldwide

[{"Type":"MASTER","Line of Business":{"code":"LOB24","label":"Security Software"},"Business Unit":{"code":"BU059","label":"IBM Software w\/o TPS"},"Product":{"code":"SSBQAC","label":"IBM Security QRadar SIEM"},"ARM Category":[{"code":"a8m0z000000cwszAAA","label":"Install"}],"ARM Case Number":"","Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"All Versions"},{"Type":"MASTER","Line of Business":{"code":"LOB24","label":"Security Software"},"Business Unit":{"code":"BU059","label":"IBM Software w\/o TPS"},"Product":{"code":"SSTDPP","label":"IBM Cloud Pak for Security"},"ARM Category":[{"code":"a8m0z0000001h8uAAA","label":"Install \/ Upgrade"}],"Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"All Versions"},{"Type":"MASTER","Line of Business":{"code":"LOB24","label":"Security Software"},"Business Unit":{"code":"BU059","label":"IBM Software w\/o TPS"},"Product":{"code":"SSKMKU","label":"IBM QRadar on Cloud"},"ARM Category":[{"code":"a8m0z000000cwszAAA","label":"Install"}],"Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"All Versions"}]

Document Information

Modified date:
29 August 2022

UID

ibm16613847