Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

Table of Contents

Children Display

 

Here is the plan for the ToC. Each entry here will be its own page. There are annotations below, under each heading.

Table of Contents

This is the general idea:

  • Users will consume this information beginning in one of two places: the home page (pre or post login) or from an application feature page
    • The links from the login page and post-login home page in the customer-specific deployment of the app will take the user to their program-specific page, that is not listed in the hierarchy (to make it less likely that customers will view other customer-specific stuff and get confused)
    • The feature links, such as from a training set page, will link to a public page that is generic to the application, such as the Train to Score page in the main set
  • The customer-specific page for each customer will include ALL the information that is unique to the customer along with an annotated, link-based guide for using the application, e.g., start here, do this, the documentation calls it "X," but you will see "Y" and so on.
  • Doing it this way means most links are stable across customers and only two links from the customer-instance of the application need to be changed on a per-customer basis: links from the login page and post-login home page in the customer-specific deployment of the app

For a demo, I will start with the AZ page, explain that it will be the starting place for most users, and then proceed through a typical use case.

Understand Scoring Online User Guide

Short introduction with links to other content.

Include Getting Started section with links to Create an Account, Edit Account Details, and System Basics.

Will include all important info worth keeping from old PDF that is not otherwise listed.

Create an Account

Link to this page from within the app for generic, app-specific, mechanics-of-use-based information.

Edit Account Details

Link to this page from within the app for generic, app-specific, mechanics-of-use-based

System Basics

An overview of the main features of Understand Scoring

Train to Score (better name? something more generic?)

Link to this page from within the app for generic, app-specific, mechanics-of-use-based

"Training Set" is customer-specific to AZ. Other customers will have different names.

No separation for different types of sets. Whether it is something like KPT or Writing Stage IV, the mechanics are very similar. Discuss possible variations clearly, with example, but be clear that the reader may see something slightly different.

Practice Scoring (better name? something more generic?)

Link to this page from within the app for generic, app-specific, mechanics-of-use-based

"Practice Set" is customer-specific to AZ. Other customers will have different names.

No separation for different types of sets. Whether it is something like KPT or Writing Stage IV, the mechanics are very similar. Discuss possible variations clearly, with example, but be clear that the reader may see something slightly different.

Qualify as a Scorer (better name? something more generic?)

Link to this page from within the app for generic, app-specific, mechanics-of-use-based

"Qualification Set" is customer-specific to AZ. Other customers will have different names.

No separation for different types of sets. Whether it is something like KPT or Writing Stage IV, the mechanics are very similar. Discuss possible variations clearly, with example, but be clear that the reader may see something slightly different.

AZ-specific stuff (page exists outside the hierarchy, needs better name)

Link to this page from:

  • The login page (current PDF link)
  • Within the app from the Training box on the main page after login
  • Within communications with the customer, such as training materials or program team emails

To be used only for customer-specific information.

Will include:

  • Access URL
  • Policy info
  • Custom names for things
  • Contact info for help/support
  • Annotated links to pages above, presented in an intelligent, thoughtful, training-focused order

Customer2-specific stuff (page exists outside the hierarchy, needs better name)

Same as AZ, but focused on this customer.

Customer3-specific stuff (page exists outside the hierarchy, needs better name)

Same as AZ, but focused on this customer.

...