Skip to content

docs: restructure user-stories by scene then user type (v1.1) - #10

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

argszero merged 1 commit into
mainfrom
docs/user-stories-scene-structure

Conversation

@argszero

Copy link
Copy Markdown
Owner

Summary

Restructures docs/user-stories.md (v1.1) per host review feedback on PR #9: the document is now organized by deployment scenario first, then user type (场景 → 用户类型 → story), instead of a flat role layout.

This addresses the host rant 2026-08-14T20:07:34 ("重构用户故事文档 — 按'场景 → 用户类型 → story'组织").

Related Issue

N/A (host instruction rant; follow-up to PR #9)

Changes

  • Document split into two top-level scenes: ## 公共场景 Public Scenario and ## 企业场景 Enterprise Scenario, each opening with a scene description (deployment form, who has sharing motivation, per docs/architecture.md)
  • Public scene lists 4 user types: 访客/新用户 (Visitor/New User), 普通用户(消费者)(Regular User/Consumer), 分享者 (Sharer), 平台运营者/管理员 (Platform Operator — marked 规划中/Planned)
  • Enterprise scene lists 2 user types: 企业管理员 (Enterprise Admin), 企业成员/员工 (Enterprise Member/Employee)
  • Each user type contains Goals / Pain points / User Stories (standard As a … / I want … / so that … + Acceptance Criteria) / Key Flow (mermaid + steps)
  • All v1.0 content reused (21 stories, 4 key journeys, 12 edge cases) with ownership re-assigned to scenes
  • Cross-scene shared capability section (API Key Management, US-21); edge/exception scenarios retained as a common chapter with scene tags (【公共】/【企业】/【通用】)
  • Version bumped to v1.1; header notes this restructure

Tests

  • cargo test passes (1 passed)
  • cargo fmt --check passes (no code change)
  • Markdown sanity check: balanced code fences, 2 scenes, 4+2 user types, 21 stories, 5 mermaid blocks, 12 scene-tagged edge cases

Checklist

  • 分支命名符合约定(docs/)
  • Commit message 使用 Conventional Commits 格式
  • 单一职责,改动最小化(仅 docs/user-stories.md)

Reorganize docs/user-stories.md from a flat role layout to a
two-level structure: ## 公共场景 Public / ## 企业场景 Enterprise,
each listing its user types (Goals / Pain points / User stories /
Key flows). Reuses all v1.0 material (21 stories, 4 journeys,
12 edge cases) with ownership re-assigned; edge cases now tagged
by scene (public/enterprise/shared); operator role marked 规划中.
Version bumped to v1.1.
@argszero
argszero merged commit cb67b8c 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