Completed
Last Updated: 21 Jan 2020 14:55 by ADMIN
Travis
Created on: 26 Sep 2014 17:35
Category: Kendo UI for jQuery
Type: Feature Request
7
Improve documentation
I know there are a number of requests for this, and I'm in agreement with all of them. I wanted to post a couple of specific examples in order to make it clear what would save me (a developer using Kendo for production code) time in implementing widgets within our application.

1. Provide information about all aspects of any given topic. For example, I recently tried to understand how sorting works for Grid. (see  http://www.telerik.com/forums/where-is-the-documentation-on-performing-case-insensitive-sorting-for-grid). It seems like it would take a pretty minimal effort to include information in the docs for grid column-header sorting (http://docs.telerik.com/kendo-ui/api/javascript/ui/grid#configuration-sortable) that describe how to turn off case-insensitive sorting, as well as explain that the grid option does not sort data on initial load (for that you need to sort on the dataSource). It required a fair amount of searching, and a couple of days to come to this understanding, which could have completely been avoided by adding a paragraph or two to the docs examples I just mentioned. For any configuration option, or feature documentation, make it complete and describe it entirely.

2. Utilize hyper-linking more effectively within the docs. A while back, I wanted to understand how to fully utilize the numericTextBox widget, and the docs mentioned 'format' for numerics. Unfortunately, I don't know what 'format' means in the context of Kendo widgets. Eventually, I found this forum post: http://www.telerik.com/forums/where-is-documentation-on-format
As I pointed out in my comment in that post, there's simply no reason to require your users to search for what 'format' means, when with minimal effort on your part, a link can be added and I can simply click to that documentation and get the answer I need.

There's a ton of individual examples that fall into one of those two categories, and if those were fixed, about 60% of the documentation issues I encounter would be resolved. I appreciate the chance to express this, and thanks for your consideration.
2 comments
dbCF
Posted on: 18 Oct 2016 07:57
I'd like to remember the support ticket 1042221 from June 2016 which asks for sorted method names in the API documentation for Kendo MVC...
ADMIN
Telerik Admin
Posted on: 29 Sep 2014 12:57
Thank you for the feedback and for the provided concrete examples for useful cross-linking in documentation articles. I will forward it to our documentation writers to be taken into account for future help updates.