Skip to content

docs(readme): 四象限评审补齐入门门槛/导航/风控 + 修 outcome 文档缺口 - #56

Merged
currycan merged 1 commit into
masterfrom
docs/readme-onboarding-quadrant
Jul 11, 2026
Merged

docs(readme): 四象限评审补齐入门门槛/导航/风控 + 修 outcome 文档缺口#56
currycan merged 1 commit into
masterfrom
docs/readme-onboarding-quadrant

Conversation

@currycan

Copy link
Copy Markdown
Owner

背景

用「重要性 × 完成度」四象限评估 README 的完整性与用户适配度。评估结论:安全语义、退出码/编排、配置单源等中级+用户轴很扎实,但纯小白入门轴有 3 处结构性缺口(准入门槛/导航/观演人添加)——正是圆桌评审「抢票小白」画像的盲区。本 PR 补齐高重要·低完成象限。

改动(纯文档,零代码)

🔴 高重要·差 → 补齐

  • 顶部「适用人群与准入门槛」:一句话「✅适合 / ⛔不适合」+ 硬门槛表(安卓真机 / 命令行 / adb / 大麦就绪),让不匹配用户第一屏即可止损
  • 目录 TOC:8 组锚点导航(561 行文档),每个锚点均经 docs 守卫的锚点解析测试验证能命中标题
  • FAQ#4 补「如何在大麦 App 添加观演人」:具体菜单路径 + 强调 users 与 App 内姓名逐字一致;3.准备配置处加跳转
  • 新增「风险与合规提示」小节:账号/风控/封号风险、仅限个人正当使用、风险自负——此前风险仅 FAQ 一句带过
  • 修事实缺口:退出码表补上 PR fix: probe 模式不再把预先存在的未支付订单误报为「抢票成功」 #55 引入却漏文档的 preexisting_pending_order outcome(exit-0 行 + outcome 枚举)

⚪ 顺手清矛盾:Desktop 已判「不可用」却仍给可执行命令 → 折进 <details> 存档

测试

  • test_docs_config_examples.py 33 passed(含锚点解析、无幽灵字段 udid/item_url、CONFIG_EXAMPLE 块逐字节未动)
  • 纯文档改动,零代码/零覆盖率影响
  • 真机安全探测回归见 PR 评论

🤖 Generated with Claude Code

用「重要性 × 完成度」四象限评估 README 后补齐高重要·低完成项:
- 顶部新增「适用人群与准入门槛」:一句话适合/不适合 + 硬门槛表
  (安卓真机 / 命令行 / adb / 大麦就绪),小白第一屏即可自我筛选
- 新增目录 TOC(8 组锚点,均经 docs 守卫锚点解析测试验证)
- FAQ#4 补「如何在大麦 App 添加观演人」具体路径,强调 users 与 App
  内姓名逐字一致;3.准备配置处加跳转
- 新增「风险与合规提示」小节(账号/风控/封号风险、仅限个人正当使用、
  风险自负),此前风险仅在 FAQ 一句带过
- 修事实缺口:退出码表补上 PR #55 引入却漏文档的 preexisting_pending_order
  outcome(exit-0 行 + outcome 枚举)
- Desktop 历史启动命令折进 <details>,不再与「已不可用」自相矛盾

纯文档改动,零代码;docs 守卫 33 passed(含锚点解析、无幽灵字段、
CONFIG_EXAMPLE 块未动)。

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@currycan
currycan merged commit bb92a96 into master Jul 11, 2026
5 checks passed
@currycan
currycan deleted the docs/readme-onboarding-quadrant branch July 11, 2026 08:29
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