Skip to content

UX: Documentation Information Architecture #120

Description

@pmady

Our documentation is scattered across multiple files:

  • README.md (overview, quick start, architecture)
  • DESIGN.md (technical decisions)
  • FAQ.md (common questions)
  • docs/ folder (detailed guides)
  • TROUBLESHOOTING.md (debugging)
  • MIGRATION.md (from DCGM)

We need a UX researcher to:

  1. Map the current information architecture
  2. Identify different user personas (platform engineer, ML engineer, contributor)
  3. Propose a restructured IA that serves each persona's needs

Deliverable

A documentation restructure proposal including:

  • Current IA map
  • Persona definitions and their documentation needs
  • Proposed new IA structure
  • Migration plan (what moves where)

Acceptance Criteria

  • Defines at least 3 user personas
  • Maps current docs to persona needs
  • Proposes clear IA improvements
  • Includes implementation plan

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationuxUser experience and design

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions