Performance troubleshooting scenario template

• Directly under the header-title box, there should be a concise page description.
• All pages should say they are IN PROGRESS until the final review. Understandably, this is a wiki and things change, but as we are doing our page development in plain view, it will be important to let readers know content isn't complete or hasn't passed a review cycle.

• Remember that each page should be self-contained. Potential readers may arrive here by Internet search or via a link, and so the page should be reasonably self-explanatory.

Header content

• Edit the page title if necessary by replacing the %TOPIC% keyword in the header-title box with real words, spaces and punctuation. (Note that's what's been done to this page because Grant got confused between Scenario and Situation.)
• The Authors: section at top should show Performance Troubleshooting Team.
• Individual authors can be listed at the bottom in the Contributors section.
• Ensure the %REVINFO% keyword is present. We use the day, month, year format.
• Ensure the Build Basis line is present. Edit it to specificy CLM 4.x

Page title

• The page's title should be clear and unambiguous. Do spend time to find the fewest, clearest words.

Page contents

• The page contents will be created automatically if you use headers.

Initial assessment

• Be as specific as possible. These suggested sub-sections may not be relevant or appropriate for each situation. However, please try to specify: application, user role, platform, etc.

Symptoms

• "When you do X, Y happens"

Impact / scope

• Does it effect multiple users? A particular type of client?

Timing (when)

• When did the problem start to occur?
• Is the problem repeatable?

Environmental changes

• What sort of things may have changed in the environment (outside the products) to have caused the problem?
• Hardware / software / network / client

Recommended data gathering and subsequent analysis steps

• Link to other, separate self-contained pages which offer concrete domain analysis (how to analyze AIX lpars, x86 virtualization, JVM heap); use parts of Tox' doc which provides high-level concepts of how things work (authentication, etc.); how to begin to look if you don't understand the whole process.

Possible causes

• Clearly identify possible causes for the problem.

Possible solutions

• Clearly identify possible solutions to the problem.

• Sometimes causes and solutions may go together especially if there's an evident cause and effect.

Keywords to aid searching

• List keywords that well help users find the page; keywords may eventually link to a glossary or other reference content. It may be we also use meta-tags eventually, but for now, a list of keywords on each page will suffice.

General comments about content (Ground Rules)

• Ocean boiling is not allowed. Please be pragmatic. Please be aware that those contributing to this effort are knowledgeable, but this is not anyone's full time job.
• Content needs to be accurate, true, useful, pragmatic, respectful.
• All planning, status and wiki-related thoughts need to be done within this wiki. No outside emails, no slide decks, no external .pdfs. We want to use the wiki to demonstrate what we are doing and the best way to do that is to learn to the wiki itself as effectively as possible.
• Content is in English.
• Headings and titles should be in sentence case.
• CLM 4.x is the minimum release version.
• Be aware that everything added here, all edits and comments are visible and editable by everyone.

For further reference

Related topics:

• Performance Troubleshooting
• Related topics must be ALWAYS part of the wiki; this section should only link to other pages on this wiki
• ALWAYS link back to the parent Performance Troubleshooting page.

• For more troubleshooting topics, refer to Performance Troubleshooting.

External links:

• External links are all links outside the wiki, this includes other pages at jazz.net, ibm.com and all outside pages.
• If there are no external links, then remove this section

• Use the format "Title of the page": "URL"
• ALWAYS spell out (the full url) the external link location
• IBM: http://www.ibm.com
• Turboencabulator: http://en.wikipedia.org/wiki/Turboencabulator

• If you point to a technote, or use an url that is unclear, provide the title of the linked page.
• Always be sure the links have http:// in them

If you use the WYSIWYG editor

• Be mindful that the WYSIWYG editor strips the closing </ div></ div> tags from the editable window. These tags permit the left menu to show up at the left and not at the bottom.

Related topics:

• Deployment web home

External links:

• None

Additional contributors:

• None

Comments

• All pages should have a comment box. We're using the technique of creating a second page to hold comments. This is because the actual content may not be editable by every reader. A separate comment page can be open to everyone with write privileges. Be sure to bring along the header otherwise it's just a box without any indication. Be sure the comment box is at the absolute end of the page.