AgentSkillsCN

read-doc

在编写或修改代码之前，务必先查阅官方文档。当用户提到“使用 X”“借助 X 库”“用 X 来创建/构建/实现/修复/更新某项功能”“帮我解决 X 相关的问题”，或提及任何库、框架或包的名称（如 gsap、framer-motion、three.js、zustand、zod 等），并希望编写、修改、修复或更新代码时，应优先参考此技能。

SKILL.md
--- frontmatter
name: read-doc
description: Fetch official documentation before writing or modifying code. Use when user says "using X", "with X library", "create/build/implement/fix/update/refactor something with X", "help me with X", or mentions any library/framework/package name (like gsap, framer-motion, three.js, zustand, zod, etc.) and wants to write, modify, fix, or update code.
allowed-tools: WebFetch

Documentation Reference Generator

This is a pre-step for code generation. Fetch documentation and produce a technical reference summary that will be used for subsequent code generation.

Trigger

When user requests to generate or modify code using a specific technology/library/framework.

Workflow

Step 1: Confirm Documentation URL

Based on the technology name, suggest the official documentation URL.

Ask user with options:

I'll fetch documentation from: [url]

  • •Yes - proceed with this URL
  • •Use different URL - provide an alternative URL
  • •Ignore - skip this step, proceed without documentation reference

If user selects Ignore, skip this skill entirely and proceed to code generation using existing knowledge.

Only ask once per technology in a session.

Step 2: Fetch Documentation

Use WebFetch to retrieve the entry page. Extract:

  • •Navigation links (sidebar, table of contents)
  • •Link titles and URLs

If WebFetch fails (domain blocked, network error, etc.), inform the user:

Unable to fetch documentation from [url].

Options:

  • •Try different URL - provide an alternative documentation URL
  • •Skip - proceed without documentation reference

Do not retry the same URL. If user provides alternative URL and it also fails, skip documentation fetch and proceed with existing knowledge.

Step 3: Navigate to Relevant Page

Based on user's code requirement, match keywords with link titles and fetch the specific sub-page(s) that are most relevant.

Step 4: Generate Technical Reference Summary

Extract and summarize from the documentation:

  • •Relevant API signatures and parameters
  • •Usage patterns and examples
  • •Best practices and recommendations
  • •Common pitfalls to avoid

Step 5: Output

Produce a technical reference summary:

markdown
## Technical Reference: [technology]

### Source
- [documentation URL]

### Relevant APIs
[API signatures, parameters, return types]

### Usage Patterns
[Code examples from docs]

### Best Practices
[Recommendations from docs]

### Notes
[Important caveats or version-specific info]

This summary will be used as reference for the subsequent code generation step.