Skip to content

Docs: Improve the structure of the vulnerability severity docs

  • Start this issue's title with Docs: or Docs feedback:.

Problem to solve

There is room for improvement in the content and layout of the vulnerability severity levels docs.

Further details

N/A

Proposal

  • Remove the list of values. Reasoning: The headings already act as a list of values, presented in the page's table of content.
  • Describe (briefly) the meaning of a severity level.
  • Describe (briefly) how a severity level can be useful.
  • Split up the description of each severity level, its CVSS range, and examples. Reasoning: Make it easier to scan the information.
  • Put the per-analyzer severity level information under its own heading. Possibly split this to a separate page.

For future consideration:

I think the severity values' descriptions should be in the Vulnerability risk assessment page. The information about how each analyzer's native severity values map to the standardized severity values can be left on its own page.

Who can address the issue

Anyone.

Other links/references