documentation-research

jpoutrin 的头像作者 jpoutrin

强制在技术实施前进行在线文档研究。在实施功能时使用,通过首先研究官方文档确保代码遵循当前最佳实践。

📖 中文导读:强制在技术实施前进行在线文档研究。在实施功能时使用,通过首先研究官方文档确保代码遵循当前最佳实践。 以下正文为该技能的原始 SKILL.md 内容(英文),上方安装命令可直接使用。

name: documentation-research description: Enforces online documentation research before any technical implementation. Use when implementing features to ensure code follows current best practices by researching official documentation first.

Documentation Research Skill

This skill enforces documentation research before any technical implementation to ensure code follows current best practices.

Core Principle

NO IMPLEMENTATION WITHOUT DOCUMENTATION RESEARCH

Before writing ANY code:

  1. Search official documentation online
  2. Verify current best practices
  3. Check for deprecated patterns
  4. Report findings to user
  5. Only then proceed

Documentation Sources

Technology Primary Documentation
Django docs.djangoproject.com
FastAPI fastapi.tiangolo.com
React react.dev
Python docs.python.org
TypeScript typescriptlang.org/docs

Research Protocol

  1. Search Official Docs - Use WebSearch/WebFetch
  2. Verify Version - Check latest stable release
  3. Review Best Practices - Note recommended patterns
  4. Check Deprecations - Avoid outdated APIs
  5. Document Findings - Summarize before implementing

Report Format

📚 Documentation Research Summary
══════════════════════════════════

🔍 Technology: [Framework]
📦 Version: [Version]

✅ CURRENT BEST PRACTICES
• [Practice 1]
• [Practice 2]

⚠️ DEPRECATED PATTERNS (Avoid)
• [Pattern] - Use [alternative] instead

📖 SOURCES
• [URL]

Ready to proceed? (yes/no)

Enforcement Rules

  1. Documentation research is non-negotiable
  2. Always verify which version is being used
  3. Check for deprecated APIs before using
  4. Follow security best practices from docs