Google Season of Docs Ideas

classic Classic list List threaded Threaded
2 messages Options
Reply | Threaded
Open this post in threaded view
|

Google Season of Docs Ideas

Ben Nathanson
NumPy serves many kinds of users....The challenge: provide ways to guide those users to the parts of the documentation most relevant to them.

I have a thought on how to approach this. We know many of the communities NumPy serves; let's next identify (for ourselves, not the proposal) what each of them needs. It could be as simple as:

  Educator
  • knows...
  • needs to know...
  Researcher
  • knows...
  • needs to know..

A table like that would be useful for self-assessment and planning. It helps answer questions like:
  • Which communities are we most shortchanging right now?
  • Which communities do we feel most strongly about (our largest base, most disadvantaged, etc.)?
  • If doc D is our next doc, does it help those communities? Or maybe we want to go round-robin through communities with each new doc.
  • What assumptions can a writer make about audience background?
We're also then equipped to bring user categories out to a web page and meet the big-tent challenge head-on, with links like:
  • If you're an educator...
  • If you're a researcher...
each one taking the user to an Educator, Researcher,..., page containing links to the information they're most likely to want.


_______________________________________________
NumPy-Discussion mailing list
[hidden email]
https://mail.python.org/mailman/listinfo/numpy-discussion
Reply | Threaded
Open this post in threaded view
|

Re: Google Season of Docs Ideas

Bennet Fauber
I think I would add to this categorization which science 'domain' or
area.  Researchers's needs from agriculture and sociology may differ
much more from each other than educators's and researchers's needs
within those field differ from each other.  So, if there is an
up-and-coming area of study that is just starting to make its presence
felt in the NumPy community, they might be a good target audience, and
they might well be working on material such as what we are looking for
themselves?

On Mon, Apr 27, 2020 at 3:33 PM Ben Nathanson <[hidden email]> wrote:

>>
>> NumPy serves many kinds of users....The challenge: provide ways to guide those users to the parts of the documentation most relevant to them.
>
>
> I have a thought on how to approach this. We know many of the communities NumPy serves; let's next identify (for ourselves, not the proposal) what each of them needs. It could be as simple as:
>
>   Educator
>
> knows...
> needs to know...
>
>   Researcher
>
> knows...
> needs to know..
>
>
> A table like that would be useful for self-assessment and planning. It helps answer questions like:
>
> Which communities are we most shortchanging right now?
> Which communities do we feel most strongly about (our largest base, most disadvantaged, etc.)?
> If doc D is our next doc, does it help those communities? Or maybe we want to go round-robin through communities with each new doc.
> What assumptions can a writer make about audience background?
>
> We're also then equipped to bring user categories out to a web page and meet the big-tent challenge head-on, with links like:
>
> If you're an educator...
> If you're a researcher...
>
> each one taking the user to an Educator, Researcher,..., page containing links to the information they're most likely to want.
>
> _______________________________________________
> NumPy-Discussion mailing list
> [hidden email]
> https://mail.python.org/mailman/listinfo/numpy-discussion
_______________________________________________
NumPy-Discussion mailing list
[hidden email]
https://mail.python.org/mailman/listinfo/numpy-discussion