SuperAPI AI 工具集

user-guide-writing

写作与研究

查看项目

更新于 10-16 05:43

技能介绍

用途:该技能用于编写面向终端用户的说明文档,帮助读者理解并有效使用产品。资料列出的适用时机包括:新用户引导、功能文档、分步教程、故障排查指南、FAQ编写、发布说明、培训材料与快速入门指南。

主要能力:以“入门指南”为例,覆盖创建账户、设置首个项目、邀请团队成员等环节,采用编号步骤,并配合提示(Tip)、截图占位和“下一步”链接。教程结构包含学习目标、预计时间、难度、前置条件、编号步骤(含截图)以及结语与相关内容链接。

最佳实践:以任务为导向,聚焦用户想完成的事;使用清晰的编号顺序步骤;加入截图、图表、视频等视觉辅助;使用平实语言,避免技术术语;亲自按步骤验证说明;提供背景,解释为什么而不只是怎么做;链接相关内容;随产品变化保持更新。

资源:资料提及风格指南可参考Google Developer Documentation Style Guide,截图工具包括Snagit、CloudApp,视频可用Loom。

限制:资料未提供具体安装命令、配置方式、平台支持、收费或价格信息,也未给出可直接使用的模板文件,相关内容暂未提供。