Skip to content

docs(operations): NewAPI 运营操作手册 v4(7 文件 / 1781 行) - #1

Merged
yujipeng merged 4 commits into
mainfrom
feature/docs-operations-manual
May 25, 2026
Merged

docs(operations): NewAPI 运营操作手册 v4(7 文件 / 1781 行)#1
yujipeng merged 4 commits into
mainfrom
feature/docs-operations-manual

Conversation

@yujipeng

Copy link
Copy Markdown
Owner

交付摘要

# 文件 行数 内容定位
1 docs/operations/README.md 59 手册总索引 + 阅读顺序导航
2 docs/operations/01-platform-setup.md 401 第 1 章 平台搭建上线:从 0 到 1 的初始化配置链路(系统 → 渠道 → 模型 → 分组 → 令牌)
3 docs/operations/02-customer-onboarding.md 253 第 2 章 客户开通调用:用户/组/令牌/可见模型映射全路径
4 docs/operations/03-billing.md 326 第 3 章 计费规则与存储:倍率/次价两路径 + OtherRatios 任务/图像类倍率 + 落表字段
5 docs/operations/04-logs-stats.md 275 第 4 章 日志与统计:渠道/分组/调用日志入口 + 统计聚合口径
6 docs/operations/05-faq.md 267 第 5 章 FAQ:高频运营问题与排查路径
7 docs/operations/99-pending-items.md 200 附录 待确认事项追踪表(13 条灰区已 closed)

合计:7 文件 / 1781 行新增,0 删除,纯文档无代码改动。

验收链(v1 → v4)

  • v1:完整文档落盘
  • v2:差异验收有条件通过
  • v3:补齐 4 文件节号
  • v4:补 2 处悬挂引用 → spot-check 全绿

灰区收口

附录 99-pending-items.md 中 13 条灰区全部 closed,正文「⚠️ 详见末尾追踪表 #N」回链已校验。

HARD-GATE 状态(7 道)

  • 节号 3.1.1 → 3.1.5 单调
  • 全局 0 悬挂引用
  • 数据表/字段引用对应代码现状
  • 前端页面入口路径准确
  • 计费公式两路径完整覆盖
  • 日志统计聚合口径明确
  • 阅读顺序导航闭环

关联 issue

  • 父 issue:TES-69 — 梳理 NewAPI 运营操作全流程
  • 子 issue:TES-70 — 文档交付任务

评审建议

请项目负责人 @jipeng.yu review;合并后回 issue 评论流附 merge commit hash。

docs-maintainer and others added 4 commits May 21, 2026 13:58
Adds docs/operations/ as the consolidated operations handbook for
operators and customer-success engineers, derived from the architect's
fact-finding report under TES-69.

Sections:
- 01-platform-setup.md  Vendor → Model → Pricing → Group → Channel
- 02-customer-onboarding.md  User → Token → Topup/Redemption
- 03-billing.md  Standard / Tiered / Audio / Task with plain-language
                 formulas, raw formulas, and unit conventions
- 04-logs-stats.md  logs / quota_data tables, query entries, stat semantics
- 05-faq.md  13 high-frequency operator scenarios + grey-area action guide
- 99-pending-items.md  Open tracker for grey areas requiring architect
                       follow-up
- README.md  Index + reading guide

Baseline: origin/main HEAD 2d1ca15.
Branch policy follows v5: docs land on feature branch, no direct
push to main / develop.

Co-authored-by: multica-agent <github@multica.ai>
Round 2 sync per architect's evidence closure (TES-69 comment 87c3958d):

- Rewrite 99-pending-items.md: all 12 grey-zone items closed-2026-05-21
  with evidence chains + handling outcome; appendix lists 5 known
  improvements (audio/task gate parity, svip default, three frontend
  guards, RPM/TPM tooltip, quota_data cleanup) tracked by PJM separately
- 03-billing.md #1: add 3.1.4 explaining text-path two gates
  (SelfUseMode + AcceptUnsetRatioModel) vs audio/task path no-gate
  asymmetry for unregistered models
- 03-billing.md QuantumNous#2 (in 02): rewrite TopupGroupRatio as
  topup-side discount/markup multiplier, not billing-side; document
  formula, four payment paths, fallback 1.0 behavior
- 03-billing.md QuantumNous#9: rewrite OtherRatios as active dynamic billing
  multiplier for task/image paths (seconds/size/n), list adapters,
  clarify text-path no-op semantics; remove "reserved field" wording
- 01/02 QuantumNous#3 QuantumNous#4 QuantumNous#5 QuantumNous#6 QuantumNous#7: operational hints planted (group ref check,
  FixAbility low-peak single-instance, double-write reminder w/ note
  that automatic linkage check is not yet implemented, svip default
  workaround, ip log default-false with compliance rationale)
- 05-faq QuantumNous#8 errata: actual error message is
  MsgDistributorTokenModelForbidden ("该 token 不允许使用模型 X"),
  not "token model limit is empty"; FAQ scene 4 rewritten as full
  troubleshooting chain
- 05-faq QuantumNous#10 QuantumNous#11 QuantumNous#12: planted hints for usingGroup-only logs.group
  (open other.user_group / other.token_group after schema extension),
  RPM/TPM as 60s snapshot, quota_data cleanup via DBA
- README, 5.2 summary table, 5.3 troubleshooting matrix, and inline
  anchors updated to match new 99-pending-items.md headings

Co-authored-by: multica-agent <github@multica.ai>
…item ref

- 03-billing.md: renumber duplicate 3.1.3 section to 3.1.4/3.1.5
- 01-platform-setup.md: sync anchor QuantumNous#314 -> QuantumNous#315
- 99-pending-items.md: sync section ref 3.1.4 -> 3.1.5
- 04-logs-stats.md: drop dangling ref to non-existent appendix item

Co-authored-by: multica-agent <github@multica.ai>
- docs/operations/03-billing.md L42: '详见 3.1.3' → '详见 3.1.4'
- docs/operations/99-pending-items.md L114: '第 3 章 3.1.3' → '第 3 章 3.1.4'

QA spot-check round 3 caught these two leftover references after the
previous renumbering (3.1.3 OtherRatios → 3.1.4). Verified globally:
  grep -rn '3\.1\.3' docs/operations/ | grep -i OtherRatios → 0 hits
  Section numbering monotonic 3.1.1 → 3.1.5 in 03-billing.md

TES-69

Co-authored-by: multica-agent <github@multica.ai>
@yujipeng
yujipeng merged commit 138bc5a into main May 25, 2026
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