IBM-Cloud / docs

IBM Cloud product documentation.
Apache License 2.0
149 stars 337 forks source link

Refactor troubleshooting by product, rather than by general scenario #1023

Open jgwest opened 7 years ago

jgwest commented 7 years ago

At present, troubleshooting items are not organized by product, but rather by general scenario, for example: 'Managing apps' or 'Accessing Bluemix' (from https://console.ng.bluemix.net/docs/troubleshoot/ts_apps.html#managingapps)

However, usually a customer is coming from a specific product/technology and looking for those answers, for example, they are using a buildpack (liberty/node), service (cloudant), or tools (Eclipse Tools for Bluemix/IBM Devops Services/CF CLI), rather than thinking in terms of whether their questions fits a specific scenario.

For example, under Managing Apps, it is true that many are general issues, but about half are product-specific (Bluemix DevOps services, Eclipse Tools for Bluemix, Node buildpack, IBM Push service, etc)

The current topic organization thus requires users to essentially search through all the topics for something that matches their specific issue, rather than getting product-specific troubleshooting.

A refactoring would thus look something like this (ordered by # of issues): Managing Apps

Crystal4545 commented 7 years ago

Checked with Patrick about the plans for Support and Troubleshooting. He said that his focused writing areas are shifted to IAM. So @jenschlot it might be best to check with you. Pls suggest who is on point for the Support and Troubleshooting issues.