Skip to content

docs: 规范 SOP 格式以便技能提取与共享#254

Closed
jlu005807 wants to merge 4 commits into
lsdefine:mainfrom
jlu005807:docs/sop-format-spec
Closed

docs: 规范 SOP 格式以便技能提取与共享#254
jlu005807 wants to merge 4 commits into
lsdefine:mainfrom
jlu005807:docs/sop-format-spec

Conversation

@jlu005807
Copy link
Copy Markdown
Contributor

@jlu005807 jlu005807 commented May 1, 2026

What

添加 SOP 格式规范和初始模板,统一 GenericAgent 技能文件格式。

Why

当前 SOP 文件缺乏统一格式,导致:

  • 技能提取困难
  • 跨实例共享不兼容
  • 自动化解析受限

本 PR 提供标准化格式,解决上述问题。

Changes

  • docs/SOP_FORMAT_SPEC.md:SOP 格式规范 v1.0

    • 定义必需结构(YAML Front Matter、工作流程、错误处理等)
    • 命名规范和格式规则
    • 解析器兼容性要求
  • docs/SOP_TEMPLATE.md:初始 SOP 模板

    • 包含所有必需章节的示例
    • 可直接复制使用

Testing

  • 模板文件格式正确,可通过 Markdown 渲染
  • YAML Front Matter 可被标准解析器读取

jlu005807 added 4 commits May 1, 2026 22:07
- SOP_FORMAT_SPEC.md: SOP 文件格式标准 v1.0
- SOP_TEMPLATE.md: 初始 SOP 模板
- 删除YAML Front Matter元数据头
- 精简为4个核心部分:核心规则、快速用法、工作流程、避坑指南
- 移除不必要的权限边界表格、配置参数等冗余内容
- 更新版本历史标记v1.0已废弃
@lsdefine
Copy link
Copy Markdown
Owner

lsdefine commented May 2, 2026

Thanks for the effort, but this doesn't align with how SOPs work in GenericAgent.

SOPs here are runtime instructions for the AI agent, not human-facing documentation. They're loaded on-demand during agent execution, so the priority is being compact, practical, and directly actionable — not standardized or "shareable" in a traditional docs sense.

Each SOP has a different structure because each skill is fundamentally different. Enforcing a uniform template would actually reduce their effectiveness. The memory system (L0–L4 hierarchy) already handles organization and discovery.

Appreciate the thought, but closing this one.

@lsdefine lsdefine closed this May 2, 2026
@jlu005807
Copy link
Copy Markdown
Contributor Author

所以如果需要共享SOP时,只需要将SOP提供给GenericAgent阅读就可以了吗?

@lsdefine
Copy link
Copy Markdown
Owner

lsdefine commented May 2, 2026 via email

@jlu005807
Copy link
Copy Markdown
Contributor Author

好的,感谢解答

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants