Skip to content

docs: add product user stories (docs/user-stories.md) - #9

Merged
argszero merged 1 commit into
mainfrom
docs/user-stories
Aug 14, 2026
Merged

argszero merged 1 commit into
mainfrom
docs/user-stories

Conversation

@argszero

Copy link
Copy Markdown
Owner

Summary

Adds the product user-stories document docs/user-stories.md — the core product-design reference for future UI/backend implementation.

This addresses the host rant 2026-08-14T20:04:34 ("编写产品用户故事(User Stories)— 从不同用户角色视角描述使用流程").

Related Issue

N/A (host instruction rant)

Changes

  • Role definitions (Goals / Pain points) for 5 roles: Visitor/New User, Regular User (public), Sharer, Enterprise Admin, Enterprise Member
  • 21 user stories in standard format (As a … / I want … / so that …) with Acceptance Criteria, covering the core loops (register → get points → consume; list key → consumed → earn; enterprise configure → allocate → use) and key operations (marketplace search/filter/sort, sharing pause/delete, transactions, API Key CRUD+copy, member top-up, department management, usage reports)
  • 4 key user journeys with mermaid diagrams (public: register → first consume, share → first earning; enterprise: admin configure → employees use, employee consume → request top-up)
  • 12 edge/exception scenarios (key invalid/revoked, quota exhausted, insufficient points, department deleted → members unassigned, API key leak, etc.)
  • Alignment table with ui/ prototype and docs/architecture.md

Tests

  • cargo test passes (1 passed)
  • cargo fmt --check passes
  • Markdown sanity check: balanced code fences, all 5 roles present, 4 journeys, 12 edge cases
  • New unit tests added (N/A — docs-only change)

Covers 5 user roles (visitor, regular user, sharer, enterprise admin,
enterprise member) with goals/pain points, standard 'As a / I want /
so that' stories with acceptance criteria, 4 key user journeys (public:
register->consume, share->earn; enterprise: admin configure->employees
use, employee consume->request top-up), and 12 edge/exception scenarios.
Aligned with docs/architecture.md and the ui/ prototype.
@argszero
argszero merged commit 560ddfc into main Aug 14, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant