docs icon indicating copy to clipboard operation
docs copied to clipboard

Refactor troubleshooting by product, rather than by general scenario

Open jgwest opened this issue 7 years ago • 1 comments

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

  • General Issues
  • Bluemix DevOps services
  • Eclipse Tools for Bluemix
  • Node.js buildpack
  • IBM Push Service
  • etc

jgwest avatar Jan 16 '17 20:01 jgwest