Zowe doc planning (2019)

Our focus areas

• More tutorials, use cases
  • Provide more use case articles and tutorials to onboard new Zowe users and extenders quickly and efficiently.
  • A list of candidate use cases can be found in issue #25.
• Measure docs success with analytics and user feedback
  • Analyze Google Analytics data to get insights on user behavior and identify potential documentation improvements.
  • Enhance SEO performance to attract more visitors from Google
  • Collect more user feedback to drive documentation improvements
  • How to measure the Net Promoter Score (NPS) of our deliverables?
• Better doc site UX
  • Provide better TOC. See issue #286 and issue #344.
  • Use a theme that aligns with Zowe.org.
• Better onboarding for new users
  • Better prereq doc to help users set up the environment more efficiently
  • Better and tested install information to provide enhanced install experience
  • More videos/demos to guide installation
  • Closer collaboration with onboarding squad to identify onboarding issues and create useful content. See the onboarding squad plan.
• Migration of Zowe.org
  • Migrate to GitHub pages to allow users to propose changes
  • Reduce overlapping content on zowe.org and Zowe doc site for better integration
• Embedded assistance
  • To embed documentation as a plug-in in Zowe Desktop or in Zowe build
  • Targeted for users who don't have an Internet connection in their enterprise environment which prevents them from reading docs online.
• User feedback
  • Continue to collect and address user feedback in various channels.
  • Wiki
• Homepage redesign
  • Redesign the homepage to include more useful information. See #532

Specific short term and long term planning

Broadcom:

• API ML
  • Troubleshooting
  • AZ and AU docs refactoring
• Quick start guide/Use case articles. Adding a lightweight "Zowe CLI quick start" section to quickly walk advanced users through installation, issuing first commands, using profiles, and writing scripts. https://github.com/zowe/docs-site/issues/374
• More advanced topics will be added as time allows - Interacting with IMS/CICS/Db2, using Jenkins to run mainframe automation, etc...
• Complete and publish Zowe CLI Plug-in for IBM IMS doc and publish (In Progress)
• Improve usage documentation for how to define CLI connection details (via CLI, profiles, or environment variables). Currently missing information and lacking examples for issuing commands.
  • https://github.com/zowe/docs-site/issues/256
  • https://github.com/zowe/docs-site/issues/220
  • https://github.com/zowe/docs-site/issues/216

IBM:

• zTrial guided tour
• More interactive doc format (GIFs, videos, etc). Including: How to download and prepare the Zowe package; How to install Node for Zowe; How to install Zowe on z/OS
• More troubleshooting information
• Create documentation for new features and enhance existing documentation

Rocket:

• Document new features and processes, including:
  • Using AT-TLS to configure ZSS for HTTPS
  • The Zowe Editor
  • Enabling tracing on the Zowe Application Framework
• Improve existing documentation of the Workflows application plug-in