Skip to content

USER-STORIES.md

Latest commit

 

History

History
48 lines (36 loc) · 2.85 KB

USER-STORIES.md

File metadata and controls

48 lines (36 loc) · 2.85 KB

User Stories

Primary personas and outcome-driven stories for EmberDocs. Use these to guide planning, scope, and acceptance criteria.

Personas

  • Indie developer: ships fast, prefers zero-config and local-first tooling.
  • OSS maintainer: needs versioned docs synced with git history and easy contributions.
  • Product engineer: ships features weekly, wants searchable, navigable docs with low maintenance.
  • Technical writer: curates content and style, collaborates asynchronously with engineers.

Stories with Acceptance Criteria & Milestones

  • Indie developer bootstrap

    • Acceptance: Cloning the repository and running npm install && npm run dev creates a runnable site with sample docs, TOC, search index, and brand defaults in <5 minutes on a clean machine.
    • Milestone: MVP Phase 01 — clone-based setup, starter content, dev server script.
    • Future: MVP Phase 02 — CLI tool (npx emberdocs init) for even faster setup.

  • OSS maintainer versioning

    • Acceptance: tagging vX.Y.Z triggers version-aware routing; docs show version selector; missing tag fallback renders latest.
    • Milestone: MVP Phase 02 — git tag parser, versioned routes, selector UI, fallback logic.

  • Contributor preview

    • Acceptance: PR automatically builds preview with MDX changes; links posted to PR; build fails on lint/test errors.
    • Milestone: MVP Phase 02 — CI preview pipeline, lint/test gates, MDX render checks.

  • Reader search

    • Acceptance: ⌘K/ctrl+k opens modal; search hits titles/headings/code; p50 <50ms on sample corpus; keyboard navigation works.
    • Milestone: MVP Phase 01 — FlexSearch index, modal UI, keyboard controls, perf check.

  • Product engineer navigation

    • Acceptance: sidebar auto-generates from folder structure; highlights active route; persists expanded state on navigation and mobile.
    • Milestone: MVP Phase 01 — nav generator, route mapping, responsive sidebar.

  • Technical writer brand fidelity

    • Acceptance: typography/colors pulled from shared tokens; components enforce spacing/blocks; no page ships custom ad-hoc CSS.
    • Milestone: MVP Phase 01 — theme tokens, layout primitives, lint rule or review checklist.

  • Admin env-flagged integrations

    • Acceptance: analytics/search upgrades toggle via env; defaults to privacy-safe off; app renders without env vars set.
    • Milestone: MVP Phase 02 — env guards, safe fallbacks, docs in dev-docs/.

  • Developer visibility

    • Acceptance: each workday has dev-docs/progress/YYYY_MM_DD_progress.md; phase plans live in dev-docs/planning/; links referenced in PRs.
    • Milestone: Ongoing — process enforced from first sprint; tracked in PR template.

  • User deployment guides

    • Acceptance: dev-docs/ contains setup, customization, and deployment guides validated against current CLI/options.
    • Milestone: MVP Phase 02 — author guides after features stabilize; keep updated through beta.