IBM z/OS Documentation

Expand all | Collapse all

Integrating IBM Service and other related IBM content into IBM documentation

  • 1.  Integrating IBM Service and other related IBM content into IBM documentation

    Posted Sun May 01, 2022 03:36 PM
      |   view attached

    Overview

    This short exercise will help us understand how we can best integrate content like IBM Service articles into IBM Documentation.

    Verbatims for z/OS documentation feedback consistently include complaints of having to jump from topic to topic and IBM site to IBM site, for an answer.  Our hypothesis is that including these highly viewed articles inside IBM Documentation where relevant, will allow users access to valuable information to better solve their problems without having to visit or search multiple places

    Survey

    This exercise will take you 5 minutes or less to walk through 4 scenarios.  At the end you will send us a note to tell us which scenario you preferred and why. 



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

    Attachment(s)



  • 2.  RE: Integrating IBM Service and other related IBM content into IBM documentation

    IBM Champion
    Posted Mon May 02, 2022 08:14 AM
    I like option 4.

    ------------------------------
    Lionel B. Dyck <><
    ------------------------------



  • 3.  RE: Integrating IBM Service and other related IBM content into IBM documentation

    Posted Mon May 02, 2022 09:46 AM
    I like scenario 1.  I like the flow of the information in one window and the additional information in a new window

    ------------------------------
    Bonnie Barthel
    Senior IT Specialist
    kyndryl
    719.649.7888
    ------------------------------



  • 4.  RE: Integrating IBM Service and other related IBM content into IBM documentation

    Posted Mon May 02, 2022 02:55 PM
    3 or 4.   I prefer 3 but if it was 4 I would just right click and do "open in new tab" or "open in new window" anyway.

    ------------------------------
    Mark Zelden
    ------------------------------



  • 5.  RE: Integrating IBM Service and other related IBM content into IBM documentation

    Posted Mon May 02, 2022 03:55 PM

    Mark,

     

    You wrote

    <snip>

    3 or 4.   I prefer 3 but if it was 4 I would just right click and do "open in new tab" or "open in new window" anyway.

    </snip>

     

    I'm not sure that choice 4 is what you're thinking it is. I think choice 4 is integrating the service data with the original data.

     

    As I understand it: If the data is properly integrated there will be nothing extra/new to click on. It's what would have been there if we had gotten it right the first time.  The IBM Docs "strategy" appears to be to have all the related data in one section rather than having links to subsections. I'm not saying that I'm a fan of that strategy but it does appear to be the strategy.

     

    Peter Relson

    z/OS Core Technology Design

     






  • 6.  RE: Integrating IBM Service and other related IBM content into IBM documentation

    Posted Mon May 02, 2022 04:33 PM
    Hi Peter.   I was going by the "use the following link to experience the scenario for yourself" in the PDF:

    https://www.ibm.com/docs/en/zos/2.4.0?topic=spaces-hiperspace-caching-pdse

    "An Overview of Hiperspace Caching"  is in a box at the top.  If I click on it in example #4, the overview opens in the existing tab (Firefox) and overlays the previous content.  In the 3rd example it was similar but clicking on the box opened in a new tab - which I prefer.   If it was done like the example in #4, one could still right click the box and "open in new tab", new window or private window. 

    What am I missing?

    I just tried it with Edge also and get the same behavior. 


    ​​

    ------------------------------
    Mark Zelden
    ------------------------------



  • 7.  RE: Integrating IBM Service and other related IBM content into IBM documentation

    Posted Mon May 02, 2022 04:47 PM

    The wording of the original note had this for scenario 4:

    "Scenario 4:  The IBM Support information gets integrated inline with the IBM Documentation article."

     

    That does not mesh with what you were trying. In fact, in a subsequent note, Geoff re-phrased to me something quite different: ... clicking the link opens a new IBM Documentation where the supplemental content has been added to the document.

     

    If we consider yours as scenario 4, then the original scenario becomes scenario 5.

     

    I don't even know what the re-phrased scenario means. What does it mean to "open a new IBM Documentation" and in what was is the "supplemental content...added to the document"?

     

    I'd appreciate the team's thoughts on my case of "The IBM Support information gets properly integrated inline with the IBM Documentation article, as if we had gotten it right the first time". There's no scenario to execute for this case; it is just a thought exercise.

     

    Peter Relson

    z/OS Core Technology Design

     






  • 8.  RE: Integrating IBM Service and other related IBM content into IBM documentation

    Posted Mon May 02, 2022 04:57 PM
    If it was truly inline with the other text, that would be confusing or even annoying to me.  Being in the text box as a "side bar" in case one wants to look at it seems like a good option to me.    It's the same reason I prefer number 3 - opening in a new window.  In the current #4 example link it overlays the original content.   But that is what I thought was intended with "inline" not knowing any better.


    ------------------------------
    Mark Zelden
    ------------------------------



  • 9.  RE: Integrating IBM Service and other related IBM content into IBM documentation

    Posted Mon May 02, 2022 05:09 PM

    <snip>

    If it was truly inline with the other text, that would be confusing or even annoying to me. 

    </snip>

     

    Maybe you're not thinking of "inline with the other text" in the way I am. I referred specifically to having the data properly integrated as if it were done right the first time. I don't even know what these service documents are. Are these info APARs? I think of info APARs (et al) as the way to get the information into the eyes of the customers since we failed to provide that info properly in the books. Going forward, I'd think we'd want the info to be properly in the books.

     

    In what way would integrating this information be confusing or annoying?

     

    Can you provide an example?

     

    If it is a good idea to have a Q&A section within the normal doc, that's fine with me.

     

    Peter Relson

    z/OS Core Technology Design

     






  • 10.  RE: Integrating IBM Service and other related IBM content into IBM documentation

    Posted Mon May 02, 2022 05:41 PM
    > Maybe you're not thinking of "inline with the other text" in the way I am.

    I must not be.

    >In what way would integrating this information be confusing or annoying?
    >Can you provide an example?

    I'm at a bit of a disadvantage perhaps because I just joined this group late last week and in my digest today this survey came up.   I don't know what the original intent or overall goal is with "integrating external content" I guess.  I don't know what "service articles" means either as all these examples were just opening up additional doc on the given subject (overview of <whatever>, <whatever> basics).   I do understand the "complaints of having to jump from topic to topic and IBM site to IBM site, for an answer" referenced in the overview.

    I thought inline meant taking that information from the new tab (what overlaid the existing content) and just including it in-between the original doc being looked at.  If I didn't need it because I was a "expert" or already was familiar with whatever the additional information was (like an overview or the "basics" as in the first example), it would just get in the way.   Going back to the "service document" and your APAR reference, if this was some documentation that referenced an APAR for additional information, then I would still want that as a hot link / something to click on and I'd still want it in a new tab.  

    Can you or anyone provide an example of what this really was supposed to look like if it is wrong?



    ------------------------------
    Mark Zelden
    ------------------------------



  • 11.  RE: Integrating IBM Service and other related IBM content into IBM documentation

    Posted Mon May 02, 2022 06:10 PM

    Welcome, Mark.

     

    You really didn't miss anything.

     

    I like the way you phrase the choices.

     

    If there is separate doc, then it would be good to have a link to it. I realized, from your previous append, that you can right click on a link and direct whether to open link in a new tab or open link in a new window. That says that the functionality exists and we can work on what the right default is (which appears currently to be to open any link in the same tab, which might mean that they would not want to change that).

     

    Simply dropping text into the original, when that text was written in a different style and possibly intended for a different audience, is unlikely to be the right answer. Integrating that text to meet what it would have been if the information was planned from the beginning seems like the way to land with a cohesive result.

     

    Peter Relson

    z/OS Core Technology Design

     






  • 12.  RE: Integrating IBM Service and other related IBM content into IBM documentation

    Posted Mon May 02, 2022 06:21 PM
    Edited by Mark Zelden Mon May 02, 2022 06:23 PM
    I'm not a web site design expert, but those right clicks I mentioned are there in all the modern browsers.  I know that things can be programmed for right click that are different, but no need here.

    Example #3 was exactly like #4 but it opened in a new tab on its own and that is what I preferred.  And I didn't realize it before, but example #3 was what I assume was meant by "service document".   The "NFS Diagnostic Data Collection Guidelines" in the link from the "trouble shooting / learn more" text block comes from the IBM support site, not a manual and it opens in a new tab.   So per my original post - #3 is my choice.  

    [edit] - For #3, opening in a new tab or complete new window is really a user setting in the browser.  All the modern browsers use "new tab" by default, but it can be changed. 

    https://www.ibm.com/docs/en/zos/2.4.0?topic=capture-zos-nfs-server-debug-trace 

    which opens the link below in a new tab when you click on this box.


    https://www.ibm.com/support/pages/node/669049
    ​​​​

    ------------------------------
    Mark Zelden
    ------------------------------



  • 13.  RE: Integrating IBM Service and other related IBM content into IBM documentation

    Posted Mon May 02, 2022 06:57 PM

    There would have to be a clear rule for "By default, this link opens as a new tab" vs "By default, this link opens in the same tab".

     

    And that should apply across the whole product (ideally would apply across all the products).

     

    What comes to mind is: why should the default be different for "NFS Diagnostic Data Collection Guidelines" than for "Using z/OS component traces", for both of which there are links on this page? Would it only be things marked "Learn more" that get the "must be new tab" treatment?

     

    Peter Relson

    z/OS Core Technology Design

     






  • 14.  RE: Integrating IBM Service and other related IBM content into IBM documentation

    Posted Mon May 02, 2022 07:13 PM
    I agree.  It's different for #3 because that is how the person coded the web page and I assumed that was intentional to compare #3 vs. #4 and that #4 was considered "inline" because it didn't open in a new tab/window.    From a web design standpoint it is coded as "open in new window" ("target=_new" or "target=_blank" in HTML) and the modern browsers with tabs let you choose in your preferences if that means "in a new tab" (the default) or "in a new window" , which was the only option in older browsers without tabs.  
    ​​​​​

    ------------------------------
    Mark Zelden
    ------------------------------



  • 15.  RE: Integrating IBM Service and other related IBM content into IBM documentation

    Posted Tue May 03, 2022 04:18 PM
    From the options listed, I prefer option 4. In general, I tend to use Ctrl+F a lot to find information. Having everything integrated makes it easier to jump directly to the content I'm interested in and it maintains context with the rest of the documentation. Another example of where this works well is a tool called slate which can be tried here: https://pages.github.ibm.com/zOS-Test-Automation/focus-docs/#introduction

    ------------------------------
    Ryan Rawlins
    ------------------------------