AI 工具教程
开工核验
- 先执行
tutorial-authoring,锁定工具、平台、操作系统、目标任务、账户类型和验收方式。 - 只用产品官方文档、发布说明、定价/计划页面和实际界面核对当前功能;搜索结果摘要和二手教程只用于发现入口。
- 记录核验日期。模型名称、默认模型、额度、价格、订阅权益、区域支持、菜单位置和实验功能均视为易变信息。
- OpenAI、ChatGPT、Codex 或 OpenAI API 教程先使用
openai-docs,引用官方 OpenAI 来源。 - 按 共同辨析合同 检查产品表面、账户计划、模型、CLI/IDE 扩展与 API 是否会在当前任务中混淆。只有入口差异会改变权限、费用、数据流或成功状态时,才在操作步骤前定位。
内容主线
围绕一个可验证任务组织内容,不固定行数、场景数量或配置/文字比例。完整教程通常回答:工具解决什么问题、前置条件、最小可执行流程、如何确认成功、权限与数据如何流动、费用如何产生、常见失败如何定位、哪些能力仍有限。
- 区分网页产品、桌面应用、CLI、IDE 扩展和 API;同名功能在不同表面可能不同。
- 比较产品或模型时先锁定任务、账户、上下文、日期和评价口径;不把名称相近写成能力等价,也不把单次体验写成质量排名。
- 稳定功能、预览/实验功能和第三方扩展分开写,不把路线图当作已发布能力。
- 与同类工具比较时保持账户计划、模型、任务、上下文和日期可比;没有实测或官方依据时不做速度和质量排行。
- 可以包含命令、配置或编程代码,只保留完成任务所需部分;实际命令以
--help和官方文档核对。 - 不展示真实密钥、令牌、账户、私有仓库、聊天记录或配置全文。凭证只用占位符,并说明最小权限、存储和轮换。
截图与图件
- 界面、终端、编辑器和结果页必须来自实际运行;截图标注产品版本或核验日期,裁掉无关信息和敏感数据。
- 界面会变化时,正文以功能名称、入口条件和成功状态为主,不只依赖像素位置。
- 架构或数据流只有在权限、数据去向或多个组件关系难以用短文说明时使用
research-visuals。 - 不生成看似真实的假 UI、终端或性能结果;每张图片提供准确替代文本。
验证
- 在声明的平台与账户条件下实际完成最小流程,核对输入、输出、退出码或界面成功状态。
- 检查链接、当前版本、计划限制、隐私/数据使用表述和故障排查步骤。
- 运行教程审计,定向渲染目标文章、
sections/machine-learning.qmd和index.qmd。 - 扫描最终 HTML 的 warning/error、中文、图片、代码换行和移动端可读性。
导航
新建文章前核对编号与相近主题。更新 doc/_quarto.yml 后从 doc/ 运行 Rscript generate_sections.R,不要手工维护生成的 section 页面,也不要因单篇教程全站渲染。