跳转到主要内容

案例提交

我们欢迎社区贡献实战教程和使用案例。每一份贡献都能帮助其他人发现 AI 在工作中的新用法。

内容原则

所有提交必须遵循以下五项原则:
原则要求
可复现清楚描述环境、输入、步骤、交付物和预期结果,让任何人都能照着做
可验证说明如何确认任务真正完成 —— 不只是过程描述,还要有验收标准
事实与经验分开产品事实需附来源;个人经验需说明适用范围
安全优先涉及文件写入、账号、密钥、发布或外部操作时说明权限与风险
尊重隐私和版权不提交个人数据、访问凭据或无权公开的内容

教程结构

每篇教程应遵循实战教程板块使用的五要素结构:
  1. 场景 —— 读者会遇到的真实工作情境
  2. 材料 —— 开始前需要准备的文件、数据或上下文
  3. 步骤 —— 逐步操作指引(欢迎配截图)
  4. 交付物 —— 产出的具体成果
  5. 验收标准 —— 如何判断结果正确
在相关步骤中标注三种部署模式(本地 WebUI / Tauri 桌面端 / SaaS 云托管)的差异。

提交方式

  1. 在 myrm-agent 仓库提交 Issue,添加 tutorial 标签
  2. 在 Issue 正文中附上教程内容(Markdown 格式,遵循上述五要素结构)
  3. 附上相关截图或辅助文件
  4. 维护团队审核通过后,将内容集成到文档站
每个 Issue 聚焦单个教程,方便审阅。

审核标准

提交会根据以下维度审核:
  • 是否遵循五项内容原则
  • 五要素结构是否完整
  • 步骤和预期结果是否准确
  • 文字是否清晰易读
  • 是否包含产品机密、凭据或个人信息