Skip to main content

Problems arise from "documentation" links in user cPanel

Comments

3 comments

  • cPanelAdamF
    Your post prompted some great conversation within cPanel. We've been discussing other possible ways to include access to documentation AND more appropriate documentation for end-users which would help (rather than confuse). We've played around with a couple of options in our minds but haven't settled on anything yet. Ideas we've discussed are: [LIST]
  • moving the current 'in-product documentation' (those text blurbs you reference) into default UI Includes so that customers can override our content in those areas
  • altering the 'read the documentation' links to be 'tell me more' links. When clicked, the interface hide and documentation would appear which explains the interface in question. A similar link would be provided to hide this documentation and show the interface
  • loading documentation remotely from our documentation-base so that our documentation team can retain editorial control and release at will, rather than release within the confines of our product's release schedule
  • targeting our documentation to specific audiences. For example, explicitly calling out which content is for Novice End Users, or for System Administrators, or for Developers.
  • providing interface tours which, when triggered, apply annotations to important parts of the interface. Annotations like this could be used to give customers step-by-step instructions for how to use the interface. UPDATE: these ideas are by no means comprehensive. Your ideas are definitely welcome.
  • 0
  • Metro2
    Thanks for the reply cPanelAdamF, it was a nice surprise to see someone have a look at this and take interest. Awesome, actually, because it would be really nice to have some changes / options with this. I realize that this is by no means a high priority thing for cPanel but I'm glad it sparked some ideas over in the cPanel camp! I like everything you wrote so far. And honestly I'd be ecstatic to just have the ability to modify the documentation links for each section of cPanel to point to my own HelpDesk Knowledgebase articles that I've written to provide instructions custom tailored for my users. It's really nice that cPanel has taken the time to put documentation links in there to try to help end-users, but for many reasons (even in addition to the ones I posted above) it can actually kind of backfire for some of us shared hosts. In my case especially because I do restrict a lot of functions and have a certain way that I want my users to do & understand things. My custom HelpDesk articles cut down on a lot of tickets, but some users will never view them if they have the "Documentation" links right there in the cPanel itself. Would love to be able to point each of those links to their respective specific articles I've written for my users. Thanks so much for giving this a look and bouncing some ideas around! Much appreciated!
    0
  • cPanelAdamF
    One of the things I hope to do in 2016 is more end-user observations. We tried out a service in 2015 which facilitated this and we found it really valuable. In fact, in one of the tests we watched an end-user struggle with a task, click on the documentation link we are talking about, spend a few seconds skimming it, admitting that she was still confused, and then announcing that she had successfully completed the task when she definitely hadn't! The whole exercise was very revealing and I want to do much more of it in 2016.
    0

Please sign in to leave a comment.