Skip to content

Evaluate & update design of docs.sourcegraph.com

Created by: marybelzer

Problem to solve

Our docs site is only useful if users can easily find the content they're looking for. Content should be easily discoverable via browsing, and search should produce predictable and easily readable results.

Measure of success

Users can easily discover content on the docs site, and content is easy to read.

Solution summary

  1. Conduct a design audit of docs.sourcegraph.com
  2. Create new designs where needed
  3. Implement new designs

Artifacts:

What specific customers are we iterating on the problem and solution with?

  • Technical Writing Team
  • Product Team
  • Any external customers using docs.sourcegraph.com

Impact on use cases

Docs are critical for our customers to be able to use Sourcegraph to its fullest capacity, and increasing content discoverability on the docs site can help with:

  1. Developer onboarding
  2. Code reuse
  3. Code health
  4. Fixing security vulneratbilities
  5. Incident response

Delivery plan

  • TO DO