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

Review and change information architecture #102

Open
vickytnz opened this issue Nov 12, 2024 · 7 comments · Fixed by #136 · May be fixed by #144
Open

Review and change information architecture #102

vickytnz opened this issue Nov 12, 2024 · 7 comments · Fixed by #136 · May be fixed by #144
Labels
Content Improvements or additions to documentation

Comments

@vickytnz
Copy link
Contributor

The old document site is very much based on the NHS Frontend install https://nhsuk.github.io/nhsuk-frontend/ which is a different use case from the prototype kit.

It makes more sense to align it with a mix of:

This would help:

  • people understand the value of the product
  • get started easily
  • use other documentation as is needed
  • get support if they need it
@vickytnz vickytnz changed the title Review and change structure of document site Review and change information architecture Nov 19, 2024
@vickytnz
Copy link
Contributor Author

Current site

Home

  • Get started
    • Install guide
      • What computer are you using
        • Windows guide (8 steps)
          * Terminal
          * Install Node.JS
          * HTML text editor
          * Download the kit
          * Download and decide where to keep your prototypes
          * Go to your prototype
          * Set up the kit
          * Run the kit
          * Check it works
        • Mac guide (8 steps)
          * Terminal
          * Install Node.JS
          * HTML text editor
          * Download the kit
          * Download and decide where to keep your prototypes
          * Go to your prototype
          * Set up the kit
          * Run the kit
          * Check it works
    • Advanced install guide
  • Guides
    • Build a basic prototype using the NHS.UK prototype kit
      • Open your prototype in your editor
      • Create pages
      • Link your pages together
      • Use components from the Design System
      • Add a textarea to question 2
      • Show the user’s answers on the ‘Check answers’ page
      • Let the user change their answers
      • Show different pages depending on user input (branching)
      • Link your index page to your start page
    • (Learn the basics)
      • Making pages
      • Adding CSS, JavaScript and Images
      • Using components
    • (Create journeys with data)
      • Passing data page to page
      • Branching (show a different page based on user input)
    • (Share your prototype)
      • Setting up Git
      • Publish your prototype online
    • Updating the kit
    • (Advanced usage )
      • Switching from the GOV.UK Prototype Kit
  • Templates (list of 16 pages)

Footer

  • About and support
  • NHS.UK prototype kit - Github
  • Cookies

@frankieroberto
Copy link
Contributor

@vickytnz nice site map! 🙌

My current thoughts for a future top-level nav/IA are:

Just an idea though!

@vickytnz
Copy link
Contributor Author

vickytnz commented Nov 19, 2024

This ties in with #136 of making the guides landing page work harder which i think also makes it easier to make decisions about how all of those pages fit together.

The footer also needs to include the accessibility statement #94 and privacy notice #95 so I think the footer should be:

The main unknowns are:

  • the benefits Add page to explain the benefits of prototyping in code #50 - which hopefully can just be on the home page with everything moving to either the main menu or the footer
  • whether contributing and support go into the main menu or the footer - normally contribution would go in the footer but it may be worth making it more prominent here

@frankieroberto
Copy link
Contributor

@vickytnz footer list looks good. I’d also agree that the GitHub links moves to being within the 'Contribute' page or wherever else relevant.

Contribute and Support feel important enough to go in the top nav (and the footer?) but 🤷. Maybe the kind of thing that some future research could tell us?

@frankieroberto
Copy link
Contributor

@vickytnz not sure how this got closed. Reopened.

@vickytnz
Copy link
Contributor Author

tbh this is almost an epic with all of the different parts, I possibly accidentally closed this with the reformatting of the guides page

@vickytnz vickytnz linked a pull request Nov 21, 2024 that will close this issue
@vickytnz vickytnz added the Content Improvements or additions to documentation label Nov 22, 2024
@vickytnz
Copy link
Contributor Author

I'd like to add a getting started button (as I think that would also mean we can move it out of the sections and make it thirds) but something is off with the reversed button in that the text won't show up?

image with hero section and button with no text showing

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content Improvements or additions to documentation
2 participants