Versions Compared

Key

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

...

We propose replacing these user stories with these users and descriptionsinterests:

1. User (a Data Scientist)

    • New to CDAP
    • Developing a Hydrator Pipeline

2. Administrator/Operator (of networks or clusters)

    • Installing CDAP
    • Operating CDAP

3. Architect (or a CxO, a corporate officier)

    • Reviewing CDAP abstractions and components

4. Developer (of Java or other supported languages)

    • New to CDAP
    • Developing a first Java Application
    • Developing a first Plugin
    • Looking for an answer to a particular question

...

It's possible that certain users may fall into more than one category. For example, a User may want to install CDAP themselves, in a Standalone setting, as part of a review process, in order to evaluate its appropriateness for their situation before passing it to an Administrator/Operator for adding it to a cluster.

We can identify paths either by user or by theme, where the themes would be the interests listed above.

Wikipedia identifies three broad approaches to the organization of documentation:

Approach

User Level
TutorialBeginner
ThematicIntermediate
List or ReferenceAdvanced

Of these different approaches, we employ all of these, and will suggest these as the user advances in level.