520-user-manual

star 1

用户使用手册编写技能。编写用户操作文档时触发:(1)编写使用手册与快速入门指南, (2)整理FAQ与故障排查方案, (3)编写功能说明与培训材料。

axeon By axeon schedule Updated 6/14/2026

name: 520-user-manual description: 用户使用手册编写技能。编写用户操作文档时触发:(1)编写使用手册与快速入门指南, (2)整理FAQ与故障排查方案, (3)编写功能说明与培训材料。 alwaysApply: false author: "axeon(23231269@qq.com)" version: "1.0.0"

用户使用手册编写

项目环境检测

从当前目录向上查找 project-info.md,最多 3 层,找到后记为 PROJECT_ROOT。详见 检测方法与前置检查未找到 → 使用当前工作目录作为 PROJECT_ROOT(阶段5文档交付允许独立于项目目录使用)。

角色职责

角色 职责 智能体
主导 手册编写 test-engineer
协作 功能确认 product-manager
协作 界面截图 js-developer
协作 完整性确认 project-manager

交付物清单

文档 格式 必需
用户使用手册 Markdown/PDF
快速入门指南 Markdown/PDF
FAQ常见问题 Markdown
故障排查指南 Markdown
操作视频 MP4 ⚠️ 可选

文档结构

用户使用手册

1. 系统简介
   - 系统概述
   - 系统要求
   - 术语说明
2. 快速开始
   - 账号注册
   - 账号登录
   - 界面介绍
3. 功能指南
   - 各模块操作说明
4. 常见问题
5. 故障排查
6. 附录

编写流程

1. 收集资料

  • 获取系统功能清单
  • 收集界面截图
  • 了解目标用户群体

2. 编写手册

  • 编写系统简介
  • 编写快速开始指南
  • 编写功能操作指南
  • 整理FAQ
  • 编写故障排查

3. 评审发布

  • 团队评审
  • 用户试用
  • 修改完善
  • 归档发布

编写原则

原则 要求
用户视角 避免技术术语,通俗易懂
步骤清晰 操作步骤详细、可执行
图文并茂 配合截图说明
覆盖全面 覆盖所有用户可见功能

⚠️ 完成验证(强制,全自动执行)

开发工作完成后,立即按以下顺序自动执行

  1. 强制调用 521-user-manual-review
  2. 如果评审不通过(< 95),自动修复问题,然后回到步骤 1(最多 5 轮)
  3. 直到评审通过(≥ 95),才向用户报告最终结果

此流程全自动执行:中间不暂停、不询问、不汇报。 未收到通过确认前,禁止结束本技能任务。

输出要求

存储位置: manual/user-manual/

目录结构:

manual/user-manual/
├── user-manual.md        # 完整用户手册
├── quick-start.md        # 快速入门指南
├── faq.md                # 常见问题
├── troubleshooting.md    # 故障排查指南
├── videos/               # 操作视频(可选)
└── reviews/              # 评审报告(REVIEW评审产出)
    └── REVIEW-USERS-MANUAL-YYMMDDHHMM.md  # 按时间戳命名,24小时制

参考

Install via CLI
npx skills add https://github.com/axeon/uw-spec --skill 520-user-manual
Repository Details
star Stars 1
call_split Forks 0
navigation Branch main
article Path SKILL.md
More from Creator