SuperAPI AI 工具集

user-guide-writing

写作与研究

查看项目

更新于 10-16 04:59

技能介绍

用途:为最终用户撰写清晰实用的用户指南与教程,覆盖新功能说明、新用户引导(onboarding)、操作指南(how-to)与 FAQ 页面。

主要能力:提供四类内容的写法与结构——快速入门(Quick Start)、任务导向的操作指南(How-To)、FAQ、学习导向的教程(Tutorial)。示例中给出创建账号、完善资料、创建首个项目等步骤,导出数据的操作指南,账号、计费、功能、技术等 FAQ 分组,以及构建仪表盘的分步教程。

必要用法:按分步骤(1、2、3)结构编写,包含截图/动图等视觉引导,使用面向用户的语言。输出建议的组织结构为 docs/ 目录,含 getting-started.md、how-to/、tutorials/、faq.md、images/ 等。

强制规则:必须包含截图;必须采用分步骤说明;必须使用用户语言。禁止:滥用技术术语(如 API、endpoint 等);使用长段落。

最佳实践:以用户视角撰写;用截图、GIF、视频“展示而非陈述”;界面变更时及时更新文档。

适用场景:产品文档、帮助中心、新手引导材料、功能发布说明与教程内容。

限制:资料未提供具体平台集成方式、安装命令、收费信息或技术实现细节;兼容平台标记为 Claude、ChatGPT、Gemini,版本 1.0.0。