用途
本技能用于为已实现的产品编写面向最终用户的综合使用手册,指导用户逐项学习并操作软件产品。其定位是“最终用户文档”阶段的第一个技能,输出物作为最终用户采用系统时的主要参考。文档遵循 ISO 26514(用户文档)标准,采用指导性、面向用户、面向任务的语气。
主要能力
手册按如下顺序组织内容:
- 文档头——产品名称、版本、日期、读者对象、标准引用。
- 目录——可自动导航的章节链接。
- 快速上手(Getting Started)——首次用户的上手流程与快速开始任务,包括系统访问(登录、注册、初始设置)、首次运行配置或向导步骤、主界面布局导览,以及在五分钟内体现核心价值的快速开始任务。
- 导航总览(Navigation Overview)——应用导航地图,包含主要导航元素(菜单、侧边栏、工具栏)及截图占位符、逐页或逐屏摘要与用途说明、可用的导航快捷方式与键盘加速键。
- 功能指南(Feature Guides)——针对 features.md 中每个功能单独成节,包含功能用途与用户收益、编号的逐步操作流程、截图占位符、关键步骤后的预期结果、边界情况与限制。
- 基于角色的工作流(Role-Based Workflows)——若有 user_stories.md,按用户角色定义工作流;识别角色、映射各角色可用的功能与典型任务序列、产出端到端流程走查;若无用户故事,则依据功能分组生成工作流。
- 故障排查(Troubleshooting)——常见面向用户问题的记录与解决方案,包括错误消息目录(通俗解释与解决步骤)、上手阶段常见障碍、性能或显示问题及建议操作、未解决问题升级路径。
- 术语表(Glossary)——领域与产品术语,按字母排序;手册中出现的每个缩略语均应展开,技术术语应给出友好定义。
- 支持与联系(Support & Contact)——升级路径与联系信息。
技能还包含证据与质量要求:产出用户手册证据记录(来源标识、范围/版本、决策、检查、例外与审批状态)和验证记录(检查项、结果——通过/失败/未评估、证据位置、日期与执行者)。质量上要求输出基于来源上下文、可追溯、可验证,分离事实、推断、假设与审批,不得相互混淆。另要求在撰写时应用反 AI 空话规范,并在关键检查点与发布时进行空话审查。
工作方式与输入
技能按八个步骤执行:读取上下文文件;定义快速上手章节;生成导航总览;生成功能指南;生成基于角色的工作流;生成故障排查章节;生成术语表;组装并写出输出。
必需输入:
- projects/<ProjectName>/_context/vision.md(产品目的、目标受众、高层目标)
- projects/<ProjectName>/_context/features.md(带描述的功能列表)
可选输入:
- projects/<ProjectName>/<phase>/<document>/SRS_Draft.md(详细功能需求,用于精确操作步骤)
- projects/<ProjectName>/<phase>/<document>/user_stories.md(用户故事与人物角色,用于基于角色的工作流)
必需输入缺失时应停止并通知用户。
输出:
- projects/<ProjectName>/<phase>/<document>/User_Manual.md(完整手册)
- 该文档目录下的 manifest.md,列出章节文件及正确组装顺序,以确保构建脚本按预期顺序组装。
权限与降级模式
默认只读;读取和搜索所提供的工件是必需的。编辑仅限明确授权的草稿或项目文件。仅在被授权时执行验证;发布、签名、认证、生产变更、破坏性操作、开支与风险接受均需明确授权。
当文件、工具、网络、渲染、字体、执行或证据不可用时,返回最窄范围的有用限定草稿或发现集,说明每一项不可用检查及其后果;未评估的检查绝不视为通过。保留已收集的证据,并给出确切的下一步验证动作。
决策规则
- 特征、界面或答案未在产品或已批准来源中确认:省略或标记为待验证,避免记录不存在的行为。
- 流程缺少成功或恢复状态:发布前补齐两者,避免用户在出错后无所适从。
适用场景与限制
适用:产品已实现,需为最终用户提供结构化操作指南时。按资料,建议在 Phase 02 完成且 vision.md 与 features.md 存在之后使用;当 user_stories.md 存在(Phase 05 后)可提供更丰富的工作流上下文;当 SRS_Draft.md 存在(Phase 02 后)可作详细功能参考。
不适用:当更具体的上游或下游技能拥有该任务,或所需项目上下文尚未准备时。不得用该技能编造缺失的项目事实、法律结论、测试结果、审批或认证声明。
明确限制:不得用假设替代具名项目来源;不得将不可访问的检查视为通过;不得使用“足够”“安全”“易用”等模糊门槛;不得套用通用模板而缺少产品、控制、角色、版本或管辖区细节;不得在未获授权时发布、签名、认证、变更生产或接受风险;不得只列证据而无来源或验收结果。
验证要点
User_Manual.md 须包含全部九个章节;快速上章须假设用户零基础并含快速开始任务;features.md 中每个功能都应有对应功能指南;截图占位符遵循 [Screenshot: Name - Step] 格式,且仅在获得已验证图片文件后才替换;基于角色的工作流覆盖每个已识别角色;故障排查含错误消息与解决步骤;术语表覆盖手册中所有缩略语与技术术语;目录链接与实际章节标题一致。
相关技能集成
上游:Phase 02(需求工程)提供 vision.md 与 features.md;Phase 05(测试文档)提供 user_stories.md。下游:03-faq 在生成 FAQ 时引用该手册进行交叉链接;Phase 09(合规)中用户手册为合规文档可追溯性提供输入。
其它资料
技能附带资源包括 logic.prompt(包含逐步生成逻辑的可执行提示)与 README.md(快速开始指南)。参考资料提到:生成逻辑(创建完整工件时加载)、技能说明(本地示例与调用上下文)、仓库运行规则(应用引擎的路由、证据与发布门禁)。
收费、价格、平台支持等事实资料未提供。