AgentSkillsCN

soyio-docs-proofread

校对Soyio文档的变更,严格执行STYLE_GUIDE.md规范,并确保面向后端的集成指南中包含API参考链接或相关注意事项。

SKILL.md
--- frontmatter
name: soyio-docs-proofread
description: "Proofread Soyio documentation changes, enforce STYLE_GUIDE.md, and ensure backend-oriented integration guides include API reference links or admonitions."

Soyio docs proofread

Goal

  • Improve clarity and correctness for developers integrating Soyio.
  • Keep content aligned with STYLE_GUIDE.md.
  • Ensure integration guides with backend examples reference the corresponding API resource.

Scope

  • Primary scope: files under docs/.
  • For integration backend flows, focus on docs/integration-guide/.
  • Do not edit autogenerated API resource files in docs/api/resources/.

Workflow

  1. Identify changed docs
  • Use git diff and limit review to docs files or a user-provided file list.
  1. Read like an integrator
  • Verify each step is understandable, actionable, and ordered correctly.
  • Flag and fix missing prerequisites, unclear wording, or ambiguous instructions.
  1. Proofread language quality
  • Fix spelling, grammar, punctuation, and typographical issues.
  • Improve sentence flow while preserving technical precision.
  1. Validate style consistency
  • Apply STYLE_GUIDE.md rules (tone, terminology, formatting, MDX usage).
  • Keep terminology consistent across sections (API, SDK, backend, webhook, etc.).
  1. Validate backend-to-API traceability
  • For integration-guide content that mentions backend/server-side implementation or shows backend code examples, ensure there is at least one of:
    • An admonition that links to the corresponding API resource(s), or
    • A direct link to the corresponding API resource(s) in the API reference.
  1. Apply fixes directly
  • Edit the documentation files with concise, user-focused improvements.
  • Keep links working and prefer existing project link conventions.

Deliverable

  • A concise list of updated files.
  • A short summary of what was improved.
  • Any remaining risks or follow-up suggestions (if applicable).