SuperAPI AI 工具集

user-guide-writing

写作与研究

查看项目

更新于 10-15 17:14

技能介绍

用途

user-guide-writing 是一个文档类技能,适用于交付物是面向客户或面向管理员的文档、目的是帮助用户在产品中完成某个工作流的场景。它是文档集群的锚点,覆盖:入门/首次成功指南、教程与引导式演练、基于任务的 how-to 文章、FAQ 及支持导向的答案集、发版后针对已上线 UI/工作流变更的帮助更新,以及由一个主页面加最少配套文档组成的小型指南集。

主要能力

  • 先对请求做规范化分类,确定一种主模式:getting-started(通往首次成功的最短路径)、tutorial(带上下文与里程碑的引导式学习)、how-to(快速完成一个实际任务)、faq(简洁的重复问题加深入指南导流)、release-help-update(在已上线 UI/工作流变更后修补用户文档)。
  • 同时确认读者(终端用户/管理员/经理/混合/未知)、经验水平、文档呈现面、可信来源、维护需求和输出形态。
  • 在写作前确认读者、任务与导流边界,并明确哪些相邻技能不属于本次范围。
  • 收集最小必要的用户可见证据:当前 UI 标签、导航与状态;前置条件、权限与套餐假设;每步预期结果;可能的阻塞、空状态与分支条件;必要的截图或截图占位;支持问题/搜索词/重复失败信号;以及使当前指南过时的发版变更。
  • 选择最小的适配结构,避免产出大而全的手册。
  • 输出最小可用的文档包,默认可为:单页、指南+FAQ、刷新包、小型指南集。

使用方式

技能给出了 8 个步骤:第 1 步分类一种主模式;第 2 步确认读者、任务与导流;第 3 步收集最小用户可见证据;第 4 步选择最小适配结构;第 5 步输出最小可用文档包;第 6 步应用用户文档写作规则;第 7 步执行维护与同步检查;第 8 步返回简报或成品。 写作规则包括:以任务和读者开头而非实现细节;尽早写明角色、权限、套餐限制、所需数据、浏览器/应用/版本等前置条件;优先可观察动作;每页保持一个主要结果;标出角色相关 UI 等分支条件;给出成功校验;把故障排查放在任务附近;仅在令人困惑的过渡处有意使用截图;有目的地外链(FAQ → 完整指南等)。 在正式撰写前,优先给出简报表,包含模式、所用来源材料、计划产出包与写作备注;若用户已直接要成品,则按匹配结构直接产出。

适用场景

  • 产品需要入门指南,让新用户到达首次成功结果。
  • 功能发布需要面向真实产品用户的教程或 how-to 文章。
  • 帮助中心需要基于任务的文章、FAQ 或便于排查的演练。
  • 支持痛点反复出现,答案应沉淀为持久的面向客户文档。
  • 工作流变更后,需要更新现有用户可见步骤、截图、警告或前置条件。
  • 请求实际只需要一个指南加少量配套文档,而非庞杂的混合用途文档。

限制

当主要工作是内部规格、架构文档、ADR、运行手册、迁移计划或面向构建者的实现指南时,应使用 technical-writing;当主要工作是 API 参考、SDK 文档、webhook 文档、开发者快速入门或开发者门户内容时,应使用 api-documentation;当主要工作是发行说明、CHANGELOG.md、迁移公告或已上线变更摘要时,应使用 changelog-maintenance;当主要工作是演示文稿、发布演示、工作坊幻灯片或视觉评审产物时,应使用 presentation-builder;当主要工作是产品定位、营销信息、生命周期邮件文案或发布文案时,应使用 marketing-automation;当主要工作是构建应用内引导机制或产品导览 UX 时,应先使用相关产品/UX 技能,再用本技能写持久的书面配套文档。用户资料未提供收费标准、价格、具体平台支持等信息。