Product Documentation
- Mark as New
- Bookmark
- Subscribe
- Mute
- Subscribe to RSS Feed
- Permalink
- Report Inappropriate Content
‎11-28-2017 08:03 AM
Hi all,
I was wondering what general opinions there are out there on the product documentation, developer docs etc?
I'm asking because I often find them hard to use, and not as user friendly or helpful as the Wiki of the olden days.
For instance,
I just searched for 'email.body_text' in the Istanbul documentation and the developer docs. I got very little back in the search results that was immediately useful.
Do any of you good people of the community have any similar frustrations, or thoughts on how best to make use of the docs?
Jamie
- Mark as New
- Bookmark
- Subscribe
- Mute
- Subscribe to RSS Feed
- Permalink
- Report Inappropriate Content
‎11-29-2017 10:03 AM
Hi Dave - Thanks for your feedback. If you spend some time reading all my other responses, you will know that we are actively working on fixing the issue that you bring up.
Yeah, Katie & Sharon had also shown me some changes that had been made - the newer pages definitely look nicer!
We have actually been working on this specific problem for most of this year. When you have over 40,000 pages of content, it takes a bit of time to restructure all of them.
Can't say I envy you!
We are currently on track to have consolidated the pages that represent 80% of all page views over the last 3 months by the end of next month. It is my hope that you will see a significant improvement from this.
That's pretty fast going! I take it this is only for a specific family, or are you also looking at historical releases only?
We also do watch our statistics very closely. As for visits, over the last year the doc site visits have gone up 116% while wiki has gone down by 41%. The doc site was launched back in 2015, so these statistics don't represent the full picture, since inception, but hopefully give you some indication of the difference in trends between the two.
From those stats, It's clear the Docs are being utilised more. I know many have mentioned looking on Wiki to gain the basics then switching to Docs for "knowledge top-up" to compare differences, but it sounds like Wiki is fast falling out of usage. Certainly we're approaching the point at which the newer products (that won't be found on Wiki) begin to form the majority of desired content, driving visitors to Docs.
As for the "why", the benefits, the situations and the examples - we will work to improve this significantly. Often these are out there, but on different pages and so it seems that they don't exist, but in other cases it is true that they just don't exist. We will improve this.
Sounds like this will be addressed with your page consolidation project. However, if you're stuck for examples and the like, feel free to throw some queries in my direction. I volunteered some content for docs some time back but never received any response.
- Mark as New
- Bookmark
- Subscribe
- Mute
- Subscribe to RSS Feed
- Permalink
- Report Inappropriate Content
‎11-29-2017 01:18 PM
Hi Dave - As for the breadth of focus for the page consolidation (defragmentation) we are applying it to Istanbul, Jakarta and Kingston. So you won't see the impact on Geneva and Helsinki, but all others that are on the doc site.
- Mark as New
- Bookmark
- Subscribe
- Mute
- Subscribe to RSS Feed
- Permalink
- Report Inappropriate Content
‎11-30-2017 12:04 AM
Darrin Ladd wrote:
Hi Dave - As for the breadth of focus for the page consolidation (defragmentation) we are applying it to Istanbul, Jakarta and Kingston. So you won't see the impact on Geneva and Helsinki, but all others that are on the doc site.
Oh, wow - that's quite a few included in the scope there! Yeah, I consider Geneva/Helsinki deprecated, so no sense in returning to those.
- Mark as New
- Bookmark
- Subscribe
- Mute
- Subscribe to RSS Feed
- Permalink
- Report Inappropriate Content
‎11-29-2017 08:06 AM
Thanks so much Jamie, this is really helpful. We are working on combining the individual articles on the docs so that they are longer, more comprehensive articles. My hope (expectation) is that you will see more of the overview combined with the key concepts and examples all together with that change. Yet, I don't expect that we will get it perfectly right initially and would love to continue to hear your feedback and if things are getting better (or hopefully not, worse).

- Mark as New
- Bookmark
- Subscribe
- Mute
- Subscribe to RSS Feed
- Permalink
- Report Inappropriate Content
‎11-28-2017 05:29 PM
There was recently a survey done on the Product Documentation.
I hope you all left some feedback! I sure did.
The general consensus I feel is that the Product Doco is harder to use, harder to find results and slower.
The wiki was fast, and the search seemed to work quite well.
ServiceNow Nerd
ServiceNow Developer MVP 2020-2022
ServiceNow Community MVP 2019-2022