跳到主要内容

实践案例写作模板

后续你可以在这一部分写“插件与技能实践案例”。每个案例建议按同一结构写,方便读者复用。

案例标题

用一句话说明目标,例如:

用 Browser + playwright 检查 Docusaurus 文档站

背景

说明为什么需要这个流程:

  • 原来怎么做。
  • 痛点是什么。
  • 为什么适合交给 Codex。

使用的能力

列出本案例用到的插件、技能、MCP 或 CLI:

能力作用
Browser打开本地页面和截图
playwright做可重复 UI 检查
AGENTS.md提供项目规则

前置准备

写清楚读者需要先准备什么:

  • 安装哪些插件。
  • 启动哪些服务。
  • 设置哪些环境变量。
  • 是否需要登录外部 App。

操作步骤

按步骤写,尽量每一步都能复制:

  1. 启动本地服务。
  2. 让 Codex 打开页面。
  3. 检查导航和侧边栏。
  4. 记录截图和错误。
  5. 运行构建验证。

推荐提示词

请使用 Browser 打开 http://127.0.0.1:3007/docs/,检查插件与技能小册首页、侧边栏和移动端导航。发现问题后只修改文档站文件,改完运行 pnpm typecheck 和 pnpm build。

验证清单

  • 页面能打开。
  • 导航路径正确。
  • 侧边栏展开正常。
  • 移动端没有遮挡。
  • 构建通过。

复盘

最后写:

  • 这个案例适合什么场景。
  • 不适合什么场景。
  • 下次可以沉淀成哪个 skill 或 plugin。