SuperAPI AI 工具集

quick-start-guide

写作与研究

查看项目

更新于 10-15 21:08

技能介绍

用途:编写快速入门(Quick Start)、getting started 文档与 onboarding 材料,目标是让用户在5至15分钟内获得可运行结果。

主要能力:提供快速入门模板结构(标题与目标、前置条件清单、编号步骤、验证、排错、下一步);强调时间到价值优化,先展示亮点功能而非安装细节;采用渐进披露,从清晰前置条件开始逐步增加复杂度并链接深入文档;每步给出预期输出与成功判定;覆盖常见错误与修复;提供跨平台安装与路径差异示例(macOS/Linux/Windows)。

写作规范:主动语态、祈使句,面向读者用“你”,句子简短;代码示例要求完整可运行、含真实文件路径与必要导入、使用真实值;避免信息过载、模糊指令、缺失文件位置、假设读者已知、无推荐的多选项。

验证与结构:每步后给出预期输出、成功表现与常见错误修复;成功标准包括多数用户一次成功、15分钟内完成;提供检查清单(代码块已测试、输出准确、链接可用、前置条件完整、排错覆盖常见问题)。

限制:资料未提供具体产品、价格、平台支持范围或实际效果数据;模板中的命令与示例为通用占位,需按实际产品替换。