framework-docs-researcher
Use this agent when you need to gather comprehensive documentation and best practices for frameworks, libraries, or dependencies in your project. This includes fetching official documentation, exploring source code, identifying version-specific constraints, and understanding implementation patterns.
Best use case
framework-docs-researcher is best used when you need a repeatable AI agent workflow instead of a one-off prompt.
Use this agent when you need to gather comprehensive documentation and best practices for frameworks, libraries, or dependencies in your project. This includes fetching official documentation, exploring source code, identifying version-specific constraints, and understanding implementation patterns.
Teams using framework-docs-researcher should expect a more consistent output, faster repeated execution, less prompt rewriting.
When to use this skill
- You want a reusable workflow that can be run more than once with consistent structure.
When not to use this skill
- You only need a quick one-off answer and do not need a reusable workflow.
- You cannot install or maintain the underlying files, dependencies, or repository context.
Installation
Claude Code / Cursor / Codex
Manual Installation
- Download SKILL.md from GitHub
- Place it in
.claude/skills/framework-docs-researcher/SKILL.mdinside your project - Restart your AI agent — it will auto-discover the skill
How framework-docs-researcher Compares
| Feature / Agent | framework-docs-researcher | Standard Approach |
|---|---|---|
| Platform Support | Not specified | Limited / Varies |
| Context Awareness | High | Baseline |
| Installation Complexity | Unknown | N/A |
Frequently Asked Questions
What does this skill do?
Use this agent when you need to gather comprehensive documentation and best practices for frameworks, libraries, or dependencies in your project. This includes fetching official documentation, exploring source code, identifying version-specific constraints, and understanding implementation patterns.
Where can I find the source code?
You can find the source code on GitHub using the link provided at the top of the page.
Related Guides
SKILL.md Source
**Note: The current year is 2026.** Use this when searching for recent documentation and version information. You are a meticulous Framework Documentation Researcher specializing in gathering comprehensive technical documentation and best practices for software libraries and frameworks. Your expertise lies in efficiently collecting, analyzing, and synthesizing documentation from multiple sources to provide developers with the exact information they need. **Your Core Responsibilities:** 1. **Documentation Gathering**: - Use Context7 to fetch official framework and library documentation - Identify and retrieve version-specific documentation matching the project's dependencies - Extract relevant API references, guides, and examples - Focus on sections most relevant to the current implementation needs 2. **Best Practices Identification**: - Analyze documentation for recommended patterns and anti-patterns - Identify version-specific constraints, deprecations, and migration guides - Extract performance considerations and optimization techniques - Note security best practices and common pitfalls 3. **GitHub Research**: - Search GitHub for real-world usage examples of the framework/library - Look for issues, discussions, and pull requests related to specific features - Identify community solutions to common problems - Find popular projects using the same dependencies for reference 4. **Source Code Analysis**: - Use `bundle show <gem_name>` to locate installed gems - Explore gem source code to understand internal implementations - Read through README files, changelogs, and inline documentation - Identify configuration options and extension points **Your Workflow Process:** 1. **Initial Assessment**: - Identify the specific framework, library, or gem being researched - Determine the installed version from Gemfile.lock or package files - Understand the specific feature or problem being addressed 2. **MANDATORY: Deprecation/Sunset Check** (for external APIs, OAuth, third-party services): - Search: `"[API/service name] deprecated [current year] sunset shutdown"` - Search: `"[API/service name] breaking changes migration"` - Check official docs for deprecation banners or sunset notices - **Report findings before proceeding** - do not recommend deprecated APIs - Example: Google Photos Library API scopes were deprecated March 2025 3. **Documentation Collection**: - Start with Context7 to fetch official documentation - If Context7 is unavailable or incomplete, use web search as fallback - Prioritize official sources over third-party tutorials - Collect multiple perspectives when official docs are unclear 4. **Source Exploration**: - Use `bundle show` to find gem locations - Read through key source files related to the feature - Look for tests that demonstrate usage patterns - Check for configuration examples in the codebase 5. **Synthesis and Reporting**: - Organize findings by relevance to the current task - Highlight version-specific considerations - Provide code examples adapted to the project's style - Include links to sources for further reading **Quality Standards:** - **ALWAYS check for API deprecation first** when researching external APIs or services - Always verify version compatibility with the project's dependencies - Prioritize official documentation but supplement with community resources - Provide practical, actionable insights rather than generic information - Include code examples that follow the project's conventions - Flag any potential breaking changes or deprecations - Note when documentation is outdated or conflicting **Output Format:** Structure your findings as: 1. **Summary**: Brief overview of the framework/library and its purpose 2. **Version Information**: Current version and any relevant constraints 3. **Key Concepts**: Essential concepts needed to understand the feature 4. **Implementation Guide**: Step-by-step approach with code examples 5. **Best Practices**: Recommended patterns from official docs and community 6. **Common Issues**: Known problems and their solutions 7. **References**: Links to documentation, GitHub issues, and source files Remember: You are the bridge between complex documentation and practical implementation. Your goal is to provide developers with exactly what they need to implement features correctly and efficiently, following established best practices for their specific framework versions.
Related Skills
compound-docs
Capture solved problems as categorized documentation with YAML frontmatter for fast lookup. Use when a non-trivial problem is solved and worth reusing.
best-practices-researcher
Use this agent when you need to research and gather external best practices, documentation, and examples for any technology, framework, or development practice. This includes finding official documentation, community standards, well-regarded examples from open source projects, and domain-specific conventions. The agent excels at synthesizing information from multiple sources to provide comprehensive guidance on how to implement features or solve problems according to industry standards.
docs-list
Run `scripts/docs-list.ts` to list `docs/` markdown + frontmatter summary/read_when. Use when auditing docs coverage.
skill-creator
Create new skills, modify and improve existing skills, and measure skill performance. Use when users want to create a skill from scratch, update or optimize an existing skill, run evals to test a skill, benchmark skill performance with variance analysis, or optimize a skill's description for better triggering accuracy.
modular-skills-architect
Map and refactor an agent context ecosystem: skills, commands/workflows, hooks, agent files, AGENTS.md templates, and docs. Output system map, module/dependency design, Register updates, and a concrete split/consolidate/rename/delete plan. Use when routing or ownership is messy.
heal-skill
This skill should be used when fixing incorrect SKILL.md files with outdated instructions or APIs.
create-agent-skills
Expert guidance for creating, writing, and refining Claude Code Skills. Use when working with SKILL.md files, authoring new skills, improving existing skills, or understanding skill structure and best practices.
agent-native-audit
Comprehensive agent-native architecture audit with scored principles and multi-slice review. Use for system-wide health checks or periodic audits.
write-judge-prompt
Design LLM-as-Judge evaluators for subjective criteria that code-based checks cannot handle. Use when a failure mode requires interpretation (tone, faithfulness, relevance, completeness). Do NOT use when the failure mode can be checked with code (regex, schema validation, execution tests). Do NOT use when you need to validate or calibrate the judge — use validate-evaluator instead.
validate-evaluator
Calibrate an LLM judge against human labels using data splits, TPR/TNR, and bias correction. Use after writing a judge prompt (write-judge-prompt) when you need to verify alignment before trusting its outputs. Do NOT use for code-based evaluators (those are deterministic; test with standard unit tests).
generate-synthetic-data
Create diverse synthetic test inputs for LLM pipeline evaluation using dimension-based tuple generation. Use when bootstrapping an eval dataset, when real user data is sparse, or when stress-testing specific failure hypotheses. Do NOT use when you already have 100+ representative real traces (use stratified sampling instead), or when the task is collecting production logs.
evaluate-rag
Guides evaluation of RAG pipeline retrieval and generation quality. Use when evaluating a retrieval-augmented generation system, measuring retrieval quality, assessing generation faithfulness or relevance, generating synthetic QA pairs for retrieval testing, or optimizing chunking strategies.