AgentSkillsCN

docs-maintainer

维护 OpenAI Agents Go SDK 的 README 与 MkDocs 文档。适用于记录新功能、更新 API 使用指南、修复代码与文档之间的不一致，或提升示例与功能的可发现性时使用。

SKILL.md
--- frontmatter
name: docs-maintainer
description: Maintain README and MkDocs documentation for OpenAI Agents Go SDK. Use when documenting new features, updating API usage guidance, fixing inconsistencies between code and docs, or improving discoverability of examples and capabilities.

Docs Maintainer

Keep docs accurate, concise, and aligned with current code.

Documentation workflow

  1. •Confirm behavior from source code and tests.
  2. •Update the most relevant page first (README.md or docs/*.md).
  3. •Add minimal examples that reflect real API calls.
  4. •Cross-link to related docs pages.

Style rules

  • •Prefer short sections with concrete snippets.
  • •Describe defaults and caveats explicitly.
  • •Avoid marketing-only language; prioritize actionable guidance.

Consistency checks

  • •Ensure feature lists match implemented capabilities.
  • •Ensure code snippets use valid imports and current APIs.