Skip to content

docs: full content and information architecture analysis #62

@diberry

Description

@diberry

Goal

Conduct a comprehensive analysis of the Squad docs site from a content lead and information architecture perspective. The docs have grown organically across many PRs — they need a structural review to ensure coherent navigation, progressive disclosure, and no gaps or redundancy.

Scope

Content audit

  • Inventory all pages by section (Get Started, Guide, Features, Reference, Scenarios, Concepts, Cookbook)
  • Flag: duplicate content across pages, orphaned pages, missing cross-links
  • Assess: is each page in the right section? Are any misplaced?
  • Check: does the reading order make sense for a new user vs. an experienced user?

Information architecture review

  • Evaluate navigation structure: is the sidebar hierarchy logical?
  • Identify: content gaps (features documented in squad.agent.md but missing from docs)
  • Identify: content that exists but has no clear audience or purpose
  • Assess progressive disclosure: can a new user get started without drowning in advanced content?

Recommendations

  • Proposed restructuring (if needed): page moves, merges, splits
  • New pages needed (with placement)
  • Pages to deprecate or archive
  • Navigation improvements
  • Content style consistency check (Microsoft Style Guide compliance)

Deliverable

A single analysis document posted as a comment on this issue, with actionable recommendations ranked by impact.

Owner

PAO (DevRel) — content perspective
Flight (Lead) — architecture perspective

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or requestgo:needs-researchNeeds investigationsquadSquad triage inbox — Lead will assign to a membersquad:dskyAssigned to DSKY (TUI Engineer)

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions