Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc Enhancement: Browse doc by area of interest #1257

Closed
BrandonJenkins14 opened this issue Jun 8, 2020 · 1 comment
Closed

Doc Enhancement: Browse doc by area of interest #1257

BrandonJenkins14 opened this issue Jun 8, 2020 · 1 comment
Labels
area: onboarding This issue is related to overall user onboarding type: enhancement New feature or request

Comments

@BrandonJenkins14
Copy link
Contributor

Any individual will likely not need to read all of Zowe doc. There is likely a specific component(s), or task they want to perform for their role.

Do one of the following:

  • Automatically present content based on user choice. For example, the user clicks a button "system programmer" and is shown only tasks that a sys prog performs. Or, they click "Zowe CLI" and see only cli-related content.
    Or, if the automation is not feasible:
  • Create a map to areas of the site based on role or interest. The user can refer to the map and choose applicable concepts to learn about.
@BrandonJenkins14 BrandonJenkins14 added type: enhancement New feature or request area: docs Documentation issue or issues that have documentation impact labels Jun 8, 2020
@nannanli
Copy link
Member

nannanli commented Jun 11, 2020

This is very similar to issue zowe/community#472. So seems there are several dimensions of grouping content:

  • by role (sys programmar, app developer, devops engineer, contributor, etc)
  • by component (z/OS component, Zowe CLI, Zowe Explorer, etc)
  • by skill level (basic, advanced)

A map would be helpful. For each dimension, it can further drill down. So I might be a new app developer interested in developing a Zowe Desktop plug-in, and I can select all three dimensions to get a list of topics. Would be interesting to see how this is designed. A working session where different squads identify their roles and topics might be good. Something on my mind:

Role I want to Task Component Topics
App developer Develop an app on Zowe Desktop 1) Learn what the extension points are; 2) Learn Zowe Application Framework; 3) How to extend and develop on App Framework; 4) get conformance badge Zowe Application Framework Zowe architecture, Zowe extending overview, Application Framework installation topics, extending App Framework topics, conformance info, troubleshooting

@nannanli nannanli added 20PI3 area: onboarding This issue is related to overall user onboarding and removed area: docs Documentation issue or issues that have documentation impact labels Jul 14, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: onboarding This issue is related to overall user onboarding type: enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants