Skip to content
This repository has been archived by the owner on Oct 7, 2022. It is now read-only.

Identify user needs for improved user documentation #31

Open
jwflory opened this issue Apr 23, 2018 · 0 comments
Open

Identify user needs for improved user documentation #31

jwflory opened this issue Apr 23, 2018 · 0 comments
Labels
docs Adding or updating documentation onboarding Improving onboarding experience for new contributors and team members priority:med Doesn't need immediate attention

Comments

@jwflory
Copy link
Member

jwflory commented Apr 23, 2018

Better user documentation is important for people who will use MagicBox; to write effective user documentation, create a list of primary users of MagicBox and identify and prioritize new documentation

How to do it

  1. Identify / create list of primary users of MagicBox
    • Who uses MagicBox… who cares, who wants to use it?
    • Country offices? State governments? Other UN agencies? External stakeholders?
  2. Put yourself in their shoes and write list of things a type of user will want to know
    • What do they need to know? What do they want to know?
  3. Write new documentation for users of MagicBox that explains how to use and understand output

Why do it

Users are important to MagicBox. Our users shape the development direction of the project and what data or analysis is needed most urgently. Creating better user documentation not only helps end users of MagicBox, but it also lowers the "minimum activation energy" for a new contributor in an open source community. If developers understand the users and their needs, there is less wasted time during the development cycle and better focus on meeting user needs.

@jwflory jwflory added onboarding Improving onboarding experience for new contributors and team members priority:med Doesn't need immediate attention docs Adding or updating documentation labels Apr 23, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
docs Adding or updating documentation onboarding Improving onboarding experience for new contributors and team members priority:med Doesn't need immediate attention
Projects
None yet
Development

No branches or pull requests

1 participant