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.

Sign up for GitHub

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

Jump to bottom

UX Test: Docs Information Architecture #1397

Closed
7 tasks done
Madeline-UX opened this issue Feb 28, 2023 · 1 comment
Closed
7 tasks done

UX Test: Docs Information Architecture #1397

Madeline-UX opened this issue Feb 28, 2023 · 1 comment
Assignees
@Madeline-UX @Jessy-Morris
Labels
documentation 📘 Improvements or additions to documentation ux

Comments

@Madeline-UX
Copy link
Contributor

Madeline-UX commented Feb 28, 2023 •
edited
Loading

Driving Questions

What are we hoping to validate?

  • How easy can a user find the information they are looking for?
  • Are there any areas of the docs that could be easier to navigate to?
  • Does the current organization of the navigation tree make sense to users?
  • Does the search bar help the user find the information they seek?
  • How might we better organize the pages and information in the docs?

Testing Plan

  • Create a user test in Maze to gather feedback on the current Zarf Docs Information Architecture
    • Survey
    • Card Sort
    • Tree-test
  • Run test (sample - internal unicorns & k8 slack)
  • Analyze results
  • Iterate on design based on feedback or handoff to devs

Additional context

Screenshot or link to what needs to be tested

Related to issue #1383

Link to Test
@github-project-automation github-project-automation bot moved this to New Requests in Zarf Project Board Feb 28, 2023
@Madeline-UX Madeline-UX moved this from New Requests to To Do in Zarf Project Board Mar 1, 2023
@Madeline-UX Madeline-UX self-assigned this Mar 1, 2023
@Madeline-UX Madeline-UX added documentation 📘 Improvements or additions to documentation ux Ux Testing labels Mar 1, 2023
@Madeline-UX
Copy link
Contributor Author

Example Questions:

  1. On a scale of 1-10, how easy was it to find the information you were looking for on the site?
  2. Did you find the left navigation drawer helpful for browsing and finding content on the site?
  3. Were the global navigation tabs easy to use and understand?
  4. Did you find the labels for the pages to be clear and concise?
  5. Did you have any difficulty navigating between pages or finding specific information on the site?
  6. Were there any sections or pages on the site that you found particularly difficult to locate or understand?
  7. Would you suggest any changes to the site's navigation structure to make it more intuitive or easier to use?
  8. Were you able to easily find the search bar and use it to find specific information on the site?
  9. Did the organization of the content on the site make sense to you, or would you suggest any changes to the structure of the site?
  10. Overall, how would you rate the ease of use and organization of the site's navigation and information architecture?

@Madeline-UX Madeline-UX changed the title UX Test: Docs Navigation Survey UX Test: Docs Information Archetecture Mar 1, 2023
@Madeline-UX Madeline-UX changed the title UX Test: Docs Information Archetecture UX Test: Docs Information Architecture Mar 1, 2023
This was referenced Apr 19, 2023
Closed
Merged
Racer159 added a commit that referenced this issue Apr 21, 2023
@Jessy-Morris @Racer159
IA: Renaming Developer Guide to Contribute to Zarf (#1634)
79971f4 
## Description
Based on user feedback and to improve the information architecture, we
are changing the Developer Guide to Contribute to Zarf. All links
associated with the Developer Guide have been modified accordingly.

## Related Issue

Fixes #1629 
Relates to #1397 

## Type of change

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [X] Other (security config, docs update, etc)

## Checklist before merging

- [X] Test, docs, adr added or updated as needed
- [X] [Contributor Guide
Steps](https://github.com/defenseunicorns/zarf/blob/main/CONTRIBUTING.md#developer-workflow)
followed

Co-authored-by: Wayne Starr <[email protected]>
This was referenced Apr 21, 2023
Closed
Merged
Racer159 added a commit that referenced this issue May 2, 2023
@Jessy-Morris @Racer159 @Noxsios
Docs Full IA Update (#1639)
8653011 
Based on user feedback and to improve the information architecture, we
are creating a "Getting Started" folder. All links associated with the
changed files have been modified accordingly.

-  Remove operator manual
-  Create "Getting Started" file
- Move Understand the Basics, Core Concepts, and Getting Started into
one folder
-  Fix any broken links that to pointed set up and install


## Related Issue

Fixes #1628 
Relates to #1397 

[PUBLIC - Zarf Project - New Docs Information
Architecture.pdf](https://github.com/defenseunicorns/zarf/files/11297954/PUBLIC.-.Zarf.Project.-.New.Docs.Information.Architecture.pdf)

## Type of change

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [X] Other (security config, docs update, etc)

## Checklist before merging

- [X] Test, docs, adr added or updated as needed
- [X] [Contributor Guide
Steps](https://github.com/defenseunicorns/zarf/blob/main/CONTRIBUTING.md#developer-workflow)
followed

---------

Co-authored-by: Wayne Starr <[email protected]>
Co-authored-by: Wayne Starr <[email protected]>
Co-authored-by: razzle <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Madeline-UX Madeline-UX

@Jessy-Morris Jessy-Morris

Labels
documentation 📘 Improvements or additions to documentation ux
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@Madeline-UX @Jessy-Morris