user-manual · git:20261026.8d01e18 · 2026-10-26 · sha256 a94800e55f11e814
user-manual git:20261026.8d01e18A
Immutable. This exact content never changes and is served at /api/v1/blob/a94800e55f11e814.
No tool to install first
claude plugin marketplace add https://markdownregistry.com/mp/a/art_7eybq2yrll3ejods/a94800e55f11e814c7327c39cee67eff4830e5fe8f605d88dc51233d26c2976c.json
Then /plugin install user-manual@markdownregistry-7eybq2yrll3ejods in Claude Code. It installs this exact version, the one graded A here, pinned to the commit it was graded at, and leaves it there.
--- name: user-manual description: 可发布使用说明书(/manual):故事线 · 配图 regen · Manual Contract。说「使用说明书」「用户手册」时用。 --- # user-manual · 软件使用说明书 **用这个**:生成或更新**可单独发布**的操作手册(故事线 + **实机截图** + 可选 **Mermaid 示意图** + 双层验收)。**不是那个**:上线前文档↔实现走查 → **`/delivery`**;行为红绿测试 → **test**;大改版 Sprint 编排 → **plan** `DOC-*`。 母版正文**零**业务词、零演示账号、零具体仓库路径。项目命令与命名 → **Manual Contract**(`config/manual.yaml` 优先;无则 `learn/user-manual.md`)。 **详文**:`reference/pipeline.md` · `reference/manual-contract-schema.md` · `reference/extract-sources.md` · `reference/capture-profiles.md` · `reference/regen-gates.md` · `reference/reader-test.md` · `reference/storyline-template.md` · `reference/scaffold-bundle.md` **产物路径**:来自 contract 的 `doc_path`(默认落在 `docs/07|08_…` 号位)——见 `rules/execution/project-docs.mdc`;**产物为自动生成,禁止手写**,文件头须保留 `<!-- generated: manual · regenerate: /manual -->`。 ## 何时进入 - 用户说 **`/manual`** · 「使用说明书」「用户手册」「配图重新生成」「walkthrough 截图」 - plan **Done when** 含可发布操作手册 / manual regen - **`/release`** 发版前:可选 manual regen + Reader Test(见 `reference/regen-gates.md`) ## 流程(五段 · 概览) 1. **读 Contract** — `config/manual.yaml` 或 `learn/user-manual.md`;无则 AskQuestion + 用 `templates/manual-contract.example.yaml` 起草 2. **提取 / 学习** — 按 `reference/extract-sources.md` 优先级补全 storylines · shots 3. **门禁** — 项目 `verify` / `task-verify` 全绿后才 regen(发版档);见 `reference/regen-gates.md` 4. **Capture regen** — 按 `capture.profile` 跑 walkthrough → sync assets → 更新 doc(**仅** `storylines[].shots` 列出的实机图) 5. **示意图** — 概念/数据流类图号 → 正文内嵌 **Mermaid**(见 `reference/pipeline.md` §示意图);**不**进 walkthrough · **不**默认 `mmdc` 导 PNG 6. **验收** — L1 脚本(文件/链接)+ L2 Reader Test(`reference/reader-test.md`) ## 与下游分工 | 阶段 | user-manual | 不做 | |------|-------------|------| | **ia** | — | 导航结构规划 | | **test** | 复用 walkthrough spec 作 capture 输入 | 替代行为断言 | | **delivery** | — | regen 截图 · 替代 7 维走查 | | **plan** `DOC-*` | 协作写正文 · Reader Test 编排 | 替代 contract schema | | **release** | 发版档可选 regen | 跳过 verify 门禁 | ## Capture Profile 分流 | profile | 典型栈 | 详则 | |---------|--------|------| | `web-fullstack` | SPA + API | `reference/capture-profiles.md` §web-fullstack | | `web-spa-only` | 纯前端 / mock | 同上 §web-spa-only | | `electron` | Electron 壳 | 同上 §electron | | `flutter` | Desktop / Mobile | 同上 §flutter | | `native-window` | MFC / Qt / 自绘 GUI | 同上 §native-window(系统 screenshot 兜底) | Contract 未指定时:有 DOM/可访问树 → Playwright 系;仅窗口像素 → `native-window`。 ## 禁止 - 在 skill 正文写死项目 URL、账号、业务术语、具体 PNG 文件名 - 无 `verify` 绿仍声称「配图已更新」 - 用 manual regen 替代 **delivery** 或 **task-verify** - 无 Contract 时编造故事线而不标 `inferred` - 把 **概念示意图** 登记进 `storylines[].shots` 或指望 walkthrough 产出(易缺 CJK 字体 → 方框乱码) - 无字体链的 `mmdc`/插件 **静默** 导出中文 PNG 嵌入手册(须显式配置 CJK 或改用 Mermaid 源码)