Agent Skills › JamieMason/syncpack › review-docs

review-docs

GitHub

用于审查和改进Syncpack文档，确保清晰度、完整性及一致性。适用于发布前验证、现有文档优化或用户反馈不清时。通过结构化反馈提供具体改进建议，参考项目标准和共享片段。

.claude/skills/review-docs/SKILL.md JamieMason/syncpack

Trigger Scenarios

发布前文档验证优化现有文档解决文档不一致用户报告文档不清晰

Install

npx skills add JamieMason/syncpack --skill review-docs -g -y

More Options

Non-standard path

npx skills add https://github.com/JamieMason/syncpack/tree/main/.claude/skills/review-docs -g -y

Use without installing

npx skills use JamieMason/syncpack@review-docs

指定 Agent (Claude Code)

npx skills add JamieMason/syncpack --skill review-docs -a claude-code -g -y

安装 repo 全部 skill

npx skills add JamieMason/syncpack --all -g -y

预览 repo 内 skill

npx skills add JamieMason/syncpack --list

SKILL.md

Frontmatter

{
    "name": "review-docs",
    "description": "Review and improve Syncpack documentation for clarity, completeness, and consistency. Use when enhancing docs or validating before publication."
}

Review Docs

Review and improve Syncpack documentation against project standards.

When to Use

Validating docs before publication
Improving existing documentation
Ensuring consistency across pages
User reports documentation is unclear

Related Skills

Use with:

document-code — Reference for structure and locations
signal-over-noise — Apply to remove filler and obvious explanations
front-loading — Ensure actionable information comes first

Your Task

Given a documentation path, review content against standards. Suggest concrete improvements.

Quality Checklist

Clarity: First line immediately shows what it covers
Examples: Practical, show real use cases, cover major patterns
Completeness: All relevant aspects documented
Consistency: Formatting matches other docs
Conciseness: No fluff; every sentence earns space
Accessibility: Users find what they need without deep reading
Reuse: Reference shared partials when available

Review Process

Read the documentation file
Cross-reference structure with similar docs
Identify information gaps where users might get stuck
Check for shared partials at site/src/_partials/
Apply signal-over-noise: Can you cut 20% of words without losing meaning?

Review Output

Provide structured feedback:

Current State

Assessment of documentation quality and coverage

Issues Found

Specific problems with locations (section names or line references)
Prioritize by impact: clarity > completeness > polish

Recommendations

Concrete improvements with examples
Rewrite short sections if needed
Flag missing content or examples
Suggest shared partials to reuse

Priority Actions

Top 2-3 changes to make immediately

Reference

Docs: site/src/content/docs/ Shared partials: site/src/_partials/ Source of truth: src/ (Rust implementation) Local testing: cd site && pnpm run dev then verify at http://localhost:4321/syncpack