Skip to content

docs: role-based user manual V0.1 (review draft) with real system screenshots - #21

Merged
baozhoutao merged 2 commits into
mainfrom
docs/user-manual-v0.1
Sep 3, 2026
Merged

baozhoutao merged 2 commits into
mainfrom
docs/user-manual-v0.1

Conversation

@baozhoutao

Copy link
Copy Markdown
Contributor

What

Adds the role-based user manual V0.1 (review draft) — one volume, one chapter per business role — plus the 62 screenshots it is built on, and the Word build that produces it.

  • docs/手册/KPI考核管理系统-操作手册.md — markdown source (single source of truth)
  • docs/手册/图片/*.png — 62 screenshots
  • docs/交付/KPI考核管理系统-操作手册-V0.1.docx — Word deliverable
  • scripts/md2docx.cjs — now embeds markdown image lines
  • package.json — new docs:manual script
  • README.md — manual added to the document table

Structure

Chapters are derived from the permission model (six positions), not from the menu tree:

  1. Common operations (sign in, workbench, app switcher, queues, password, Excel export)
  2. HR reviewer — indicator library, plan versions, review steps, participating subjects, indicator assignment, per-person split, disputes, publishing, review/reject, bonus points, adjustment approval, archiving, audit query
  3. Department reporter — find the sheet, fill actual values, bulk import, submit, handle rejection, request a data adjustment
  4. Branch checker — my checks, confirm, raise a dispute
  5. HR head — approve bonus points, approve adjustments
  6. Executive leader — final approval, results and dashboard
  7. Cross-role FAQ table
  • Appendix A: chapter ↔ screen index (for keeping the manual in sync with UI changes)
  • Appendix B: 3–5 verifiable practice tasks per role

Every operation follows the fixed four-part shape: context → steps with annotated screenshot → how to confirm it worked → common problems.

Screenshots

All 62 screenshots come from a live instance seeded with demo data, each captured while signed in as the target role's own demo account (five demo accounts with business-style Chinese names and example.com addresses), with red boxes and numbered badges injected over the button or field the step refers to. The demo data was produced by walking one continuous business line end to end: plan configuration → publish (including a failed completeness check) → data entry → submit (including the blocked incomplete submit) → branch check (dispute, then confirm) → HR reject → re-review and approve → bonus points → source-data and result adjustments → leader approval → archive snapshot → audit query.

Word build

scripts/md2docx.cjs gains one rule: a line of the form [alt](图片/x.png) becomes a centred ImageRun scaled to the text width (PNG dimensions read from the IHDR chunk, so no image dependency is added). Captions keep the existing centred-caption rule. Everything else is unchanged — the design proposal build is byte-identical:

$ node scripts/.tmpcheck/md2docx.old.cjs docs/00-设计方案.md /tmp/old.docx
$ node scripts/md2docx.cjs docs/00-设计方案.md /tmp/new.docx
/tmp/old.docx 315947 c7453610e9ccf03bc41b6f9675a6f240
/tmp/new.docx 315947 c7453610e9ccf03bc41b6f9675a6f240

(md5 of word/document.xml; the zip container itself is not byte-reproducible because docx embeds fresh ids.)

pnpm typecheck passes. No src/ file is touched.

Notes for review

The manual documents the interface as it behaves today. Interface issues noticed while writing it (object and field labels resolving to the English bundle, raw status values and identifiers surfacing in the audit list and the person-score chart, a technical prefix on error toasts, the check-task decision maker/time not being stamped, a required status field with no default on new adjustment records) are reported separately as candidate work items rather than worked around here.

🤖 Generated with Claude Code

https://claude.ai/code/session_01VR2khJ3Me96btawVsfG6jb


Generated by Claude Code

按 os-project-impl-training 的目录生成法,从权限模型推出六个业务角色的手册结构:
通用操作一章 + 人力审核 / 部门填报人员 / 分公司核对人员 / 人力负责人 / 分管领导五章,
每个操作固定四段(场景引入 / 操作步骤+截图 / 结果确认 / 常见问题),另附常见问题总表、
手册章节与界面对照索引、各角色练习任务清单。

62 张截图全部取自演示环境的真实界面,并且用目标角色本人的账号操作截取(人力审核、
部门填报、分公司核对、人力负责人、分管领导各一个演示账号),图上用红框与序号标注要
点击的按钮与要填的字段;演示数据沿一条完整业务线产生:方案配置 → 发布(含完整性检查
不通过)→ 填报 → 提交(含未填全被拦)→ 分公司核对(争议 + 确认)→ 人力驳回 → 复核
通过 → 加减分 → 数据调整 → 领导审批 → 归档快照 → 审计查询。

scripts/md2docx.cjs 增加 markdown 图片行支持:`![alt](图片/x.png)` 按版心宽度缩放后
居中嵌入,图题沿用既有的居中图注样式;设计方案的生成结果逐字节不变(同源比对
word/document.xml 的 md5 一致)。package.json 增加 docs:manual 生成 Word 成品。

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01VR2khJ3Me96btawVsfG6jb
… evidence

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01VR2khJ3Me96btawVsfG6jb
@baozhoutao
baozhoutao marked this pull request as ready for review September 3, 2026 06:47
@baozhoutao
baozhoutao merged commit 4a02994 into main Sep 3, 2026
1 check passed
@baozhoutao
baozhoutao deleted the docs/user-manual-v0.1 branch September 3, 2026 06:49
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.

2 participants