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-30-2017 05:44 AM
I don't want people getting the impression I hate Docs, or that I don't recognize how far its come along since it started.
Ditto. People I've spoken to don't say they hate docs, just that they preferred how the Wiki worked and all felt the "successor" wasn't an improvement, more a backwards step. However, it sounds like plans are in place to improve the quality and UX of Docs.
But I'll go on record saying cutting wiki off Dec10 is a bad idea, if for no other reason that its consistently better at searching Docs than Docs is.
I don't know who decided that date, but it's effectively pressuring the Docs owners to meet and exceed the quality of the Wiki by that date - if it doesn't, there are likely to be many disgruntled users. I'd have got Docs polished first, then watched as more visitors migrated over from Wiki before deprecating Wiki - it's kinda yanking the safety net before acrobats have completed training.
Either way, there's no question that Wiki needs to be archived at some point. Despite the appearance and format, information on there is outdated[1] and I've witnessed many people on community pointing to inaccurate details or deprecated functionality for their release family.
[1] not everything, but stuff has moved on since the Fuji days, so the percentage of still-relevant diminishes as time progresses.
- Mark as New
- Bookmark
- Subscribe
- Mute
- Subscribe to RSS Feed
- Permalink
- Report Inappropriate Content
‎11-30-2017 10:53 AM
Beyond the point that you made around the fact that the information is outdated and potentially damaging if used by customers that are on versions beyond Fuji, another main reason for the retirement timing is specifically the search on the Wiki. The Google Site Search has been discontinued by Google back in April of this year. We were "grandfathered" in to continue to use it but only until early next year, when it will be automatically migrated to the new Google Custom Search Engine. With that search, Google has shifted from a pay-for-service model to a "free" ads-supported model. Therefore, if we continued with Google, we have no option but to have ads on the Wiki. That's really not acceptable and thus it heavily impacted our timing.

- Mark as New
- Bookmark
- Subscribe
- Mute
- Subscribe to RSS Feed
- Permalink
- Report Inappropriate Content
‎11-30-2017 07:06 AM
But I'll go on record saying cutting wiki off Dec10 is a bad idea, if for no other reason that its consistently better at searching Docs than Docs is. - I'll second that! It's too early.
- Mark as New
- Bookmark
- Subscribe
- Mute
- Subscribe to RSS Feed
- Permalink
- Report Inappropriate Content
‎11-29-2017 08:34 AM
Robert Fedoruk wrote:
On Wiki, each page had multiple sections. Clicking search results landed you in a comfy nest of useful information.
In many cases, Docs treats sections as whole separate pages.
This design is one of the biggest complaints I receive - that docs consists of a large number of pages with relatively little content, compared to wiki that had fewer pages with more content. It seemed people were used to hitting one long page then scrolling to sections of interest, rather then clicking further links.
Consequently this "over-normalisation" of pages increases search results, leaving readers to click many links in an effort to find their content of interest.
Curious to know if any visitor reports have been conducted on both sites: how did visitor numbers begin to drop on wiki once docs was launched, and how many visitors did wiki still continue to receive compared to docs?
I detest documentation that tersely explains: "${TOPIC}: you can ${TOPIC}". As an example, the above docs tell me I can use a global variable in inbound email actions, and that it can be used to reference fields on the email record.
But... no explanation of why I would use it, no benefits to using it, no situations when I wouldn't, no examples demonstrating its use... just "you can use it".
- Mark as New
- Bookmark
- Subscribe
- Mute
- Subscribe to RSS Feed
- Permalink
- Report Inappropriate Content
‎11-29-2017 08:57 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. 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. 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.
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.
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.