SuperAPI AI 工具集

user-guide-creation

写作与研究

查看项目

更新于 10-14 11:06

技能介绍

用途

该技能面向用户指南与操作文档的撰写,适合创建产品用户手册、入门指南、功能教程、分步操作说明、视频脚本文档、交互式演示、快速开始指南、FAQ 文档和最佳实践指南等。其目标是为用户提供清晰、易用的文档,帮助用户理解并有效使用产品。

主要能力

提供用户指南的文档结构模板,典型章节包括:目录、介绍、快速开始、主要功能、常见任务、故障排除、FAQ 和支持。介绍部分可包含“产品是什么”“本指南适合谁”等内容,并面向新用户、进阶用户和管理员等不同读者。参考目录中列出更细化的实现主题,包括系统要求、安装、初始设置,以及创建第一个项目、导入现有数据、导出数据等任务示例。

使用方式

资料给出最小可用示例:以“# [产品名称] 用户指南”为标题,建立包含 Introduction、Getting Started、Key Features、Common Tasks、Troubleshooting、FAQ、Support 的目录,并在 Introduction 下填写产品简介与目标读者。更详细的实现参见 references/ 目录中的参考指南,例如 references/system-requirements.md、references/installation.md、references/initial-setup.md、references/task-1-creating-your-first-project.md、references/task-2-importing-existing-data.md、references/task-3-exporting-data.md。

适用场景

适用于产品用户手册、入门指南、功能教程、分步 how-to、视频脚本文档、交互式演示、快速开始指南、FAQ 文档和最佳实践指南。

限制与注意事项

资料未提供该技能的具体安装方式、平台支持、收费模式或价格信息。内容中列出最佳实践:应当使用简单清晰语言、加入截图与视觉元素、提供分步说明、对顺序任务使用编号列表、添加提示/警告/注释、包含键盘快捷键、提供多条完成任务路径、测试所记录的每一步、保持内容更新、使用一致格式、为长指南添加目录、包含搜索功能;不应使用未解释的术语、假设用户已有知识、跳过重要步骤、使用过时截图、写大段文字、忘记为新版本更新、把简单任务过度复杂化。