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

📖 Update Tech Docs for user guide to use more intuitive 'contents' #6259

Open
1 task
tom-webber opened this issue Dec 10, 2024 · 0 comments
Open
1 task
Assignees
Labels

Comments

@tom-webber
Copy link
Contributor

tom-webber commented Dec 10, 2024

User Story

As a user of the platform
I need/want/expect to be able to navigate the user guide with ease
So that I can find relevant information where I expect it to be

Value / Purpose

The Analytical Platform user guide is difficult to navigate. Partially as a consequence of undesigned information architecture, and partially due to the overwhelming way the information is presented in the contents view - up to 300 entries can be visible in the left hand contents at once.

The search functionality of the docs sites can be quite poor, so doesn't offer a viable alternative to structured navigation. With this in mind, reworking the contents section will make the user guide more approachable and navigable for users.

Proposal

Improve the 'contents' view for the Analytical Platform User Guide.
Options include:

  • Contents for only one page, and indented headings viewable at any one time (see Cloud Platform or Modernisation Platform user docs)
  • Use top-level-only headings in the left hand contents for the AP user guide (page titles only). A right-hand side contents is used for headings within pages (see VSCode docs)

Definition of Done

  • User GuideContents simplified
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: 👀 TODO
Development

No branches or pull requests

2 participants