IBM z/OS Documentation

Expand all | Collapse all

Is there a need for page forward and page backward buttons for z/OS documentation in IBM Documentation?

  • 1.  Is there a need for page forward and page backward buttons for z/OS documentation in IBM Documentation?

    Posted Thu September 30, 2021 11:44 AM
    Edited by Geoffrey Smith Thu September 30, 2021 12:18 PM
    IBM Knowledge Center introduced page forward and page backward buttons.  At the time we received positive feedback mostly likely because z/OS documentation was created as books, and paging through the content using page forward and page backward was easier and more intuitive, than using the table of contents to move from page to page, but what do you think?  Is the table of contents sufficient to navigate z/OS documentation?  Or would you like to see page forward/backward buttons on every page?

    Example of Previous/Next in Knowledge Center

    ------------------------------
    Geoffrey Smith
    ------------------------------


  • 2.  RE: Is there a need for page forward and page backward buttons for z/OS documentation in IBM Documentation?

    Posted Thu October 07, 2021 04:27 PM
    As the example shows, KC implemented "previous" and "next" so we should use those terms. This function was already promised. Do we really need to revisit this? The TOC can reasonably be used to navigate only if the TOC always moves to the right place when you select a search result. In a significant percentage of cases the table of contents does not move as it is supposed to when you click on a search match.  Until that is addressed, any thought of using the TOC to navigate is inappropriate. Further, a user also might have removed the TOC from the display in order to maximize the viewable area. The prev/next buttons were always visible. So it's less convenient to use the TOC. And in at least one experimental try, if you have removed the TOC from view, even when it was pointing to the right place, when you restore it to view, it no longer is. The TOC is currently not usable as a method for navigating forward or backward. These might all be considered TOC processing defects. Regardless, they would all need to be addressed before the TOC could be usable for this purpose.

    ------------------------------
    Peter Relson
    IBM
    ------------------------------



  • 3.  RE: Is there a need for page forward and page backward buttons for z/OS documentation in IBM Documentation?

    Posted Thu October 28, 2021 11:17 AM
    Excellent point Peter.  So are you saying if the TOC performed better, we might not need page forward/backward?

    ------------------------------
    Geoffrey Smith
    ------------------------------



  • 4.  RE: Is there a need for page forward and page backward buttons for z/OS documentation in IBM Documentation?

    Posted Thu October 28, 2021 11:46 AM
    No, I am not saying that.  Prev/Next will always give the user a much better experience. That is quite clear to every user who has ever needed to navigate to "next" or "prev". 

    So if we care about our customers there's little question.  But there can be no question that, with the current state of affairs, the TOC is unusable for this purpose.  You used the word "perform". I wasn't sure if you were intending that to relate to "performance" vs "function".  There are valid concerns about TOC performance, but it is functionality and functioning that is at the heart of the problems with the TOC for navigation use.

    ------------------------------
    Peter Relson
    IBM
    ------------------------------



  • 5.  RE: Is there a need for page forward and page backward buttons for z/OS documentation in IBM Documentation?

    Posted Wed October 20, 2021 01:31 PM

    I remember first seeing Page Forward and Page Backward in the old Windows-based Library Reader. I never actually used this feature in any Book Manager, Library Reader, Information Center or Knowledge Center implementation, but it seems to be a popular request among those that have been doing so for ages.

    In the current IBM Documentation, any off-page navigation other than clicking on the TOC to the left is quite slow. Clicking a topic in the TOC to the left is light speed by comparison. I mentioned this on the one very productive meeting we had (our second one I believe) and Kerry confirmed my suspicion that navigation initiated from clicking in the page body takes a much slower path because you're working with full HTTPS links that could be cross-book, cross-release or even cross-product links.

    For this reason, I avoid off-page navigation links that appear in the page body where possible. So even if Fwd and Bwd links were provided, I would not use them unless they had the same "fast path" navigation characteristics of clicking in the TOC (which is how I always page forward and back).



    ------------------------------
    Edward Jaffe
    Chief Technology Officer
    Phoenix Software International, Inc
    El Segundo, CA CA
    ------------------------------



  • 6.  RE: Is there a need for page forward and page backward buttons for z/OS documentation in IBM Documentation?

    Posted Thu October 28, 2021 11:40 AM
    Is the TOC performance acceptable?

    ------------------------------
    Geoffrey Smith
    ------------------------------



  • 7.  RE: Is there a need for page forward and page backward buttons for z/OS documentation in IBM Documentation?

    Posted Thu October 28, 2021 11:54 AM
    Do you mean the performance of initially loading it? Do you mean the performance of moving to the right place when you navigate? It's better than it was. It's still slow. And there's still no indication that it is proceeding. When I go to the z/OS 2.4.0 page to search I get there and start typing my search term and then it gets wiped out apparently because it is working on loading the TOC.  As to the performance of moving, that would possibly be OK if it actually worked as it is supposed to. Might you want a thread on problems with TOC (in which I would include the fact that on a normal user screen, the amount of visible TOC is small and has been significantly reduced due to the unconditional introduction of the "filter").

    ------------------------------
    Peter Relson
    IBM
    ------------------------------



  • 8.  RE: Is there a need for page forward and page backward buttons for z/OS documentation in IBM Documentation?

    Posted Thu October 28, 2021 02:07 PM
    Initial TOC appearance takes from 3-10 seconds. (Just now clocked it at seven seconds.) I would indeed call that slow...

    ------------------------------
    Edward Jaffe
    Chief Technology Officer
    Phoenix Software International, Inc
    El Segundo, CA CA
    ------------------------------



  • 9.  RE: Is there a need for page forward and page backward buttons for z/OS documentation in IBM Documentation?

    Posted Mon January 10, 2022 05:41 PM
    I had another very good use case for wanting and need PREV and NEXT on the pages.   I was looking at a command in the DFSMS books.  The command (DEFINE PATH) has a set of Required Parameters, and a set of Optional Parameters.  These parameter pages are, typically, about 3-4 levels "deep" in the documentation topics.  

    Looking for the parameter I wanted, I thought it was Optional (PATHENTRY).  My luck, of course I was wrong, and it really was Required.  In this case, I really could have used a PREV (when I was on Optional and needed to go to Required) in a single click, or Next (when I was on Required and needed to go to Optional).  Without a PREV, I had to:
    1. go back in the ToC on the left,  which was not in the right location, as we've talked about the scrolling problem in the ToC not matching where in the book you are
    2. scroll through the ToC to find the element book I was in 
    3. expand that element bookshelf
    4. scroll to the right book
    5. select either the parent topic (the DFSMS command itself), or the other parameter topic (Required Parameter, for me).

    We've also talked about breadcrumbs across the top, and that would have helped me, if NEXT and PREV were not, there by making my use case:
    1. click on the DFSMS commands book itself, or even more ideally click on the command (DEFINE PATH) itself which would be across the top of the page,
    2. select parameter topic (Required Parameter, for me).
    Contrast this with the NEXT or PREV, when my clicking pattern would be:
    1. click on Required Parameter from the Optional Parameter page.  
    I can get screen shots of the above use case, if they'd help.

    ------------------------------
    Marna Walle
    z/OS Installation and Upgrade
    IBM Poughkeepsie
    ------------------------------



  • 10.  RE: Is there a need for page forward and page backward buttons for z/OS documentation in IBM Documentation?

    Posted Fri March 04, 2022 03:27 PM
    An update on page forward and backward.  This function has been implemented!  There is a previous and next at the bottom of every page.  The previous and next links provide a description of the topic title to help navigation.  Here is a sample page:

    https://www.ibm.com/docs/en/zos/2.5.0?topic=operations-planning-mvs



    ------------------------------
    Geoffrey Smith
    ------------------------------



  • 11.  RE: Is there a need for page forward and page backward buttons for z/OS documentation in IBM Documentation?

    Posted Fri March 04, 2022 05:29 PM
    Excellent!  I've already used it.  Is there a way that the buttons could be a little colored, so they don't blend in with the background so much?  It's a little hard to know that they are even a button.  

    Thanks.

    ------------------------------
    Marna Walle
    z/OS Installation and Upgrade
    IBM Poughkeepsie
    ------------------------------



  • 12.  RE: Is there a need for page forward and page backward buttons for z/OS documentation in IBM Documentation?

    Posted Fri March 04, 2022 05:35 PM
    FWIW, the "previous" and "next" are blue, and everything in blue seems to be a link.  So there is a hint that there's something to click on. Maybe the "previous" and "next" should be bold (like other links) and/or a larger font size?  Maybe the whole box should be blue since you can click anywhere in the box (I wrote that, but I probably would not want that -- I suspect an all-blue-box would be jarring and not helpful)

    ------------------------------
    Peter Relson
    IBM
    ------------------------------



  • 13.  RE: Is there a need for page forward and page backward buttons for z/OS documentation in IBM Documentation?

    Posted Sat March 05, 2022 02:28 PM
    fyi:  I tweeted and did a LinkedIn post to get this new function as widely available as possible.  I receive back two comments (but one was on a different topic).  Just wanted to pass them along to the Community: 

    1.  One of the lead z/OS systems programmers from a large banking customer in Canada:



    2. The other item was one we've known for a long time, about the ToC loading/scrolling problem:


    ------------------------------
    Marna Walle
    z/OS Installation and Upgrade
    IBM Poughkeepsie
    ------------------------------



  • 14.  RE: Is there a need for page forward and page backward buttons for z/OS documentation in IBM Documentation?

    Posted Thu August 18, 2022 10:44 AM
    Testing reply

    ------------------------------
    Ann DePaolo
    ------------------------------