tracker issue : CF-3198677

select a category, or use search below
(searches all categories and all time range)

Modernize documentation user interface design

| View in Tracker

Status/Resolution/Reason: Closed/Withdrawn/NotABug

Reporter/Name(from Bugbase): Nando Breiter / Nando Breiter (Nando Breiter)

Created: 05/25/2012

Components: Documentation

Versions: 10.0

Failure Type: Enhancement Request

Found In Build/Fixed In Build: Final /

Priority/Frequency: Normal / Most users will encounter

Locale/System: English / Platforms All

Vote Count: 0

Problem Description: The ColdFusion documentation could be made much more accessible by modernizing the user interface, and focusing particularly on the parts of the documentation that are most often accessed, which is very most likely to be the docs for tags and functions. All the navigational steps to find the documentation for a particular tag or function are not necessary anymore in a modern web interface and are cumbersome to click though again and again during programming. So what I am requesting is that the docs be enhanced so that typing in a single search field from anywhere in the documentation auto-selects results as you type. If the search term begins with "cf", tag names are returned in the evolving dropdown selection list, if not, function names are returned. Once the tag or function name is visible, clicking on it will bring the user directly to the documentation for it. This auto select search field would still be visible at the top of the page, and all you'd need to do to go to the next tag or function documentation needed is to start typing the name in the field and click the name when it appears.

While concentrating in the middle of a programming task, it's very helpful not to have to break the train of thought to find documentation. This enhancement seems minor, but I would argue that it would help us all to be more efficient programmers. Every time we have to break the train of thought and look at the somewhat cluttered help interface and think "ah, ok, where's the link for functions? Under Configuring and Administering, no, Adobe ColdFusion 10 CFML Reference, probably, Developing Adobe ColdFusion 10 Applications ummm, Installing ... no, ok click Adobe ColdFusion 10 CFML Reference ... now where are Functions? Let's see,Configuring, Installing,  Introduction, Reserved, Tags, Functions - here we go. Now ... let's see, New Functions, by Category, since ColdFusion 5, a-b, c-d, e-g, h-im, what function was I looking for again ... right ... QuerySetCell() ... ok ... m n o p q, m-r, let's click that now where's QuerySetCell() on this list of 66 functions on this page ... hmmm ... here it is!

By the time I've found the docs for QuerySetCell(), I've broken my train of thought and have to pick it up again.

Note that I am not suggesting that this search box should search the entire documentation set or all Adobe resources. There is already one at the top of the online docs that does this, but results shown create more or less the same problem, as it is not obvious until you start reading through the result list which link might go to the documentation for the tag or function you are searching for. The design goal would be to not break the train of thought a programmer is in the middle of to find the docs necessary to continue.

Thanks for considering this enhancement request.d

Steps to Reproduce:

Actual Result:

Expected Result:

Any Workarounds:

----------------------------- Additional Watson Details -----------------------------

Watson Bug ID:	3198677

External Customer Info:
External Company:  
External Customer Name: Nando Breiter
External Customer Email:  
External Test Config: My Hardware and Environment details:



This is fixed as we have moved to a Wiki environment and hence not applicable. (Comment added from ex-user id:ramachan)
Comment by Adobe D.
19207 | March 01, 2013 12:38:29 AM GMT