Skip to Main Content
Status Future consideration
Categories Knowledge base
Created by David
Created on Jun 10, 2024

Disclosure widget in knowledge base documents

What is the challenge?

Including in a knowledge base document lengthy text that needs to be available to some users without overwhelming the many users who do not need the text.

Including the text is necessary to meet the needs of knowledge base users who depend on assistive technology, which is a legal or contractual commitment for some products.

What is the impact?

If we don't include the text at all, then a knowledge base document is not usable by anyone who depends on assistive technology because they cannot access the media that the text would describe. Consequently, our product would be out of compliance with legal and contractual requirements that all our published content conform to established standards, such as Web Content Accessibility Guidelines (WCAG) 2.2.

If we do include the text, then the document becomes overly long and cumbersome to navigate for users for whom the text is superfluous because they can indeed see the media directly.

Describe your idea

Include in the document editor a way to author content that then in published documents is accessibly (i.e., conformant with Web Content Accessibility Guidelines 2.2) rendered using a disclosure: an HTML <details> element with its associated <summary> child element.


  • Attach files
  • Admin
    Sarah Moisan-Thomas
    Reply
    |
    Jul 11, 2024

    Thanks for letting us know about this. Curious to hear how you have typically configured this in other tools you've used – do you have any examples you could share? Should the same disclosure apply to all pages within the KB, or does it need to be within each document?

    1 reply