SuperAPI AI 工具集

user-guide-writing

写作与研究

查看项目

更新于 10-15 16:46

技能介绍

用途:帮助撰写清晰易读的用户指南与教程,主要覆盖新功能说明、新手引导和常见问题整理三类场景。

主要能力:可产出快速入门指南(分步骤引导用户完成注册、完善资料、创建首个项目等)、任务导向的操作指南(如导出数据,含前置说明、分步操作、故障排查与相关指南链接)、FAQ 页面(按账户与计费、功能、技术等分类组织问题)以及学习型教程(含耗时、难度、前置条件与分步构建,例如创建仪表盘)。输出结构通常按 docs 目录组织,包含 getting-started、how-to、tutorials、faq 与 images 等文件。

必要用法与写作要求:每个步骤采用 1、2、3 编号;必须包含截图等视觉说明;使用用户语言,避免技术术语。禁止堆砌术语(如 API、endpoint),禁止使用长段落,应保持简短清晰。

最佳实践:从用户视角写作,用截图、GIF、视频“展示”而非单纯描述,并在界面变化时定期更新文档。

限制:资料未提供具体安装命令、代码调用或运行方式;技能版本为 1.0.0,最后更新于 2025-01-01,兼容 Claude、ChatGPT、Gemini。文中的 MyApp、邮箱、链接与价格页面等均为示例内容,非真实产品信息。