| name | user-manual |
| description | 当用户提到「操作手册 / 使用手册 / 用户手册 / 帮助中心文章 / 带截图的 SOP 手册」时触发。 「营销稿 / 宣发稿 / 上线宣传 / 推广文案」亦触发(走 promo- 模式,两者同为面向用户的上线交付物)。 丢一份现有手册 / 营销稿要改版亦触发。「告警 SOP / 监控值班手册」不触发(那是 prd- 应急 runbook,另一物种)。
|
| type | standalone |
| output_format | .md + .docx |
| output_prefix | user-manual- / promo- |
| depends_on | [] |
| optional_inputs | ["baseline","delta","prototype"] |
| consumed_by | [] |
| scripts | {"build_manual.py":"源 md → docx(pandoc + reference.docx + callout.lua)+ 图片清单 — python3 build_manual.py <source.md> [--allow-placeholder]","check_manual.sh":"Step B 自检 — bash check_manual.sh <source.md>"} |
User Manual — Platform C 面向用户的上线交付物(手册 + 营销稿,docx + md,带截图)
触发与定位
做什么:把一个功能/活动写成面向使用者的对外产出物,两种模式共用截图获取 + 项目结构:
- 手册模式(
user-manual- 前缀):操作 / 使用手册。单源 md → pandoc 转 docx,源 md 即帮助中心可发布版。教用户怎么操作。
- 营销模式(
promo- 前缀):营销 / 宣发稿。渠道分版文案(Banner / 博客 / 更新日志)+ 配图索引,介绍功能卖点。docx 为可选产出(需发运营 / 传阅时 build)。
何时触发:手册——「操作手册 / 使用手册 / 帮助中心文章 / 带截图的 SOP」;营销——「营销稿 / 宣发稿 / 上线宣传 / 推广文案」;或丢一份旧手册 / 营销稿要改版。
不做:PRD / 需求文档(走 prd skill);告警 / 监控值班 SOP(prd- 应急 runbook);内部后台逻辑规格(归 PRD)。上线宣发三件套(视频/gif 分镜脚本 · 图文 4 宫格 · 短卖点文案,痛点→卖点→CTA,产物前缀 launch-)走 promo-kit skill;本 skill 的 promo- 只做渠道分版长文案(Banner / 官方博客长文 / 更新日志条目)。
受众:读者是运营 / 主播 / C 端用户 / 潜在用户,不是研发。正文一律业务白话,禁内部版本号 / 场景号 / 埋点名。
改脚本前 30 秒
skill-load-gate 守的是「Read 过本文件」不看读了多少行。
改本 skill scripts/*.py:Read 此文件 limit=80(前两节就够)。
改产出物(手册 md):建议全文 Read(写作规则散在 §3 / §4)。
Public API(不可改签名 · 改前看调用方):
build_manual.py <source.md> [--allow-placeholder] [--docx-out <path>] — 唯一 docx 生成入口
check_manual.sh <source.md> — Step B 自检入口
会拦你的 hook:
script-syntax-gate — pyflakes / bash -n(写 .py / .sh 自动跑)
plain-language-gate — 产物落 deliverables/ 且非 prd- 前缀 → 写盘自动 --strict 强阻断(内部锚点 / 决策号 / [待补充] / FIXME / 翻译腔禁入对外手册)
cjk-punct — deliverable md CJK 标点强阻断
learned-rules-gate — 工区习得规则
改完跑啥:
python3 .claude/skills/user-manual/scripts/build_manual.py /tmp/demo-manual.md --allow-placeholder
深入读什么(按需 grep 定位):
- 完整 API:
grep -A 20 "^## API 速查" SKILL.md
- 模板骨架:
Read references/user-manual-template.md
- 帮助中心发布:
Read references/help-center-publish.md
硬规则(FAIL 即拦)