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

Clarify "Learner's Phase" table #70

Open
chexxor opened this issue May 5, 2019 · 3 comments
Open

Clarify "Learner's Phase" table #70

chexxor opened this issue May 5, 2019 · 3 comments

Comments

@chexxor
Copy link
Owner

chexxor commented May 5, 2019

I, and perhaps @JordanMartinez also, feel that the "Learner's Phase" table in the Context/Narrative document is a little wrong in its "abstraction" of the issue. What exactly is "off" about it isn't clear, so the resolution is also not clear.

Perhaps the problem is simply that I am wanting it to be something that it isn't trying to be. For example, perhaps I want it to describe the various audiences the documentation needs to address, whereas the table is simply trying to describe the various types of documentation and invents a persona to which it is most valuable.

Motivated by this thread: https://github.com/chexxor/purescript-documentation-discussion/pull/50/files#r277185921

@chexxor
Copy link
Owner Author

chexxor commented May 5, 2019

I don't see the exact phases in the "Learner's Phase" table in https://www.divio.com/blog/documentation/, so perhaps it's an extrapolation by @JordanMartinez. If that's the case, we have more flexibility when clarifying it.

@JordanMartinez
Copy link
Contributor

The X-Y graph I was referring to is the last image in that post. The top-left corner reads "Tutorials<br>Learning Oriented". I would like to copy-and-paste that image into this repo, but that's too much of a copyright infringement in my mind.

Also, due to the influence of "Teach, don't tell," our table added a fifth type, which takes one of their types and breaks it down into two types.

@JordanMartinez
Copy link
Contributor

When I initially wrote that part, I thought about re-creating their image using HTML tables but decided against it for two reasons:

  • it seemed to close to just copying their work
  • HTML tables in a markdown file aren't very readable, so if we ever wanted to edit them, it'd be harder

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants