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

IA restructure for guides #4341

Closed
4 of 6 tasks
shannonbux opened this issue Mar 2, 2018 · 3 comments
Closed
4 of 6 tasks

IA restructure for guides #4341

shannonbux opened this issue Mar 2, 2018 · 3 comments
Assignees
Labels
type: documentation An issue or pull request for improving or updating Gatsby's documentation

Comments

@shannonbux
Copy link
Contributor

shannonbux commented Mar 2, 2018

Description

Usability testing to do after tasks below are done:

  • Develop personas of the types of people who visit gatsbyjs.org and what they're looking for (for example, non-programmers vs. engineering managers vs. experienced programmers, etc.)
  • a card sort to see how different personas naturally categorize current docs (we could throw in some new titles for docs we know we're going to create soon)
  • then do usability testing to see if the architecture has improved
  • make improvements based off of usability testing
  • Make templates for each kind of doc
  • get RFC merged

Help needed

For usability testing, I need two things:

  1. a set of 5-10 discrete tasks a person might try to accomplish by visiting the docs. I will give these tasks to people and record how they accomplish (or don't accomplish) the task.
  2. Volunteers who are willing to let me Skype with them / meet in person to watch them try to accomplish said tasks above. Volunteers would need to be unaware of the tasks ahead of time.

Re no. 3 above, here's one possible way to classify the kinds of templates we could produce for docs. On the site itself, we would want to categorize possibly by these categories with more specific categories nested inside. I'll have to find out more by usability testing.
copy of screen shot 2017-10-12 at 1 08 39 pm

@shannonbux shannonbux added type: documentation An issue or pull request for improving or updating Gatsby's documentation UX Design labels Mar 2, 2018
@shannonbux shannonbux self-assigned this Mar 7, 2018
@LekoArts
Copy link
Contributor

a set of 5-10 discrete tasks a person might try to accomplish by visiting the docs. I will give these tasks to people and record how they accomplish (or don't accomplish) the task.

Here are some ideas:

  • Installing the Gatsby CLI and starting a new project
  • Installing a plugin (Also: Are the instructions on these plugins clear enough and consistent)
  • Creating an own plugin
  • Contribute to the project (Adding README etc.)
  • See what has changed/migrating (We still lack a proper changelog)

@shannonbux
Copy link
Contributor Author

@LekoArts thanks for these ideas! Will report back after I do some testing.

@shannonbux shannonbux changed the title Usability testing for information architecture of the docs IA restructure for guides Mar 21, 2018
@shannonbux
Copy link
Contributor Author

shannonbux commented Mar 21, 2018

Updating this issue with a task list:
The sidebar is getting too long. We need to restructure the guides by

  • adding a second level of navigation with clear content categories and types
  • organize existing documents into new categories
  • publicize a way to place future docs into the right categories
    mvimg_20180314_180540

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation An issue or pull request for improving or updating Gatsby's documentation
Projects
None yet
Development

No branches or pull requests

3 participants