USWDS-Site - Feature: Create an HTML site map for USWDS

amycole501 commented 1 year ago

Is your feature request related to a problem? Please describe.

Currently, there is no HTML site map on the USWDS site. HTML site maps provide both discoverability by search engines and usability for site visitors. Site maps are recommended by WCAG and allow users an alternative method to navigate the site outside of top-level navigation.

Describe the solution you'd like

Provide a Site Map link at the bottom of every page on the USWDS site. The link will serve to connect all pages of the site to one another and provide another avenue for visitors to navigate the site if they have trouble using top-level navigation. An example of an HTML site map on a federal website can be found here on vote.gov

Create the site map using a hierarchical structure that mimics the site's content with top-level navigation and sub-navigation in proper order. See this example of a large website site map on the WAI site.

As pages are added to the site, the site map will also need to be updated. Separate site map recommendations may be necessary for sites using a content management system.

Describe alternatives you've considered

While XML site maps are routinely used by federal websites for search engines they are not a method by which someone can navigate the site. Top-level navigation is another way to navigate the site but may prove to be a barrier depending on assistive technologies or other methods used by site visitors.

Additional context

No response

Code of Conduct

[X] I agree to follow this project's Code of Conduct.
[X] I checked the current issues for duplicate feature requests.

amycole501 commented 10 months ago

@sarah-sch let's meet about this soon to determine how the content audit can inform the way we built out the site map

amycole501 commented 9 months ago

@sarah-sch and I met; next steps are:

[ ] @finekatie and Sarah will meet and create a rough draft of the existing site map along with suggestions for content reorganization

The draft should include whether or not all pages are to be shown in the HTML site map page or just primary pages. Example: don't include jump links or section links but primary component pages would appear.

We can also draft guidance on how to implement a site map when using a CMS tool where pages are added on the fly.

mejiaj commented 7 months ago

@amycole501 @sarah-sch are the next steps still accurate? Should this still be marked as triage?

amycole501 commented 7 months ago

@finekatie and Sarah are going to talk about this in our next CS/UX sync. Thanks for flagging!

uswds / uswds-site