documentation-research

Enforces documentation research before implementation. Auto-loads when implementing features to ensure current best practices are followed. Researches official docs first.

16 stars

Best use case

documentation-research is best used when you need a repeatable AI agent workflow instead of a one-off prompt.

Enforces documentation research before implementation. Auto-loads when implementing features to ensure current best practices are followed. Researches official docs first.

Teams using documentation-research 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

$curl -o ~/.claude/skills/documentation-research/SKILL.md --create-dirs "https://raw.githubusercontent.com/diegosouzapw/awesome-omni-skill/main/skills/documentation/documentation-research/SKILL.md"

Manual Installation

  1. Download SKILL.md from GitHub
  2. Place it in .claude/skills/documentation-research/SKILL.md inside your project
  3. Restart your AI agent — it will auto-discover the skill

How documentation-research Compares

Feature / Agentdocumentation-researchStandard Approach
Platform SupportNot specifiedLimited / Varies
Context Awareness High Baseline
Installation ComplexityUnknownN/A

Frequently Asked Questions

What does this skill do?

Enforces documentation research before implementation. Auto-loads when implementing features to ensure current best practices are followed. Researches official docs first.

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

# 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

Related Skills

reviewing-documentation

16
from diegosouzapw/awesome-omni-skill

Use when reviewing documentation quality, auditing README or CLAUDE.md files, or standardizing AI instruction files.

research-documentation

16
from diegosouzapw/awesome-omni-skill

Searches across your Notion workspace, synthesizes findings from multiple pages, and creates comprehensive research documentation saved as new Notion pages. Trigger on "노션 검색", "조사해줘", "리서치 정리". For meeting prep use meeting-intelligence; for saving knowledge use knowledge-capture; for spec breakdown use spec-to-implementation.

quality-documentation-manager

16
from diegosouzapw/awesome-omni-skill

Document control system management for medical device QMS. Covers document numbering, version control, change management, and 21 CFR Part 11 compliance. Use for document control procedures, change control workflow, document numbering, version management, electronic signature compliance, or regulatory documentation review.

documentation-templates

16
from diegosouzapw/awesome-omni-skill

Documentation templates and structure guidelines. README, API docs, code comments, and AI-friendly documentation.

documentation-structure-validator

16
from diegosouzapw/awesome-omni-skill

Validate documentation structure, check for missing sections, verify markdown syntax, ensure consistency with templates. Use when user mentions docs validation, structure check, README review, documentation quality, or wants to verify documentation completeness.

documentation-standards

16
from diegosouzapw/awesome-omni-skill

Clear technical documentation with JSDoc, READMEs, Mermaid diagrams, ISMS policy references, and comprehensive code examples

documentation-specialist

16
from diegosouzapw/awesome-omni-skill

文档专家。专注于技术文档编写、API 文档生成、README 优化和文档维护。提供清晰的文档结构、规范的格式和用户友好的内容。

documentation

16
from diegosouzapw/awesome-omni-skill

Technical writing, API docs, and documentation best practices

Documentation Hygiene

16
from diegosouzapw/awesome-omni-skill

This skill should be used when the user asks to perform "documentation hygiene", "update docs for change", "mark historical docs", "add deprecation headers", "documentation migration", or when making significant changes that affect multiple documentation files (like license migrations, tier changes, or API changes).

documentation-guidelines

16
from diegosouzapw/awesome-omni-skill

Write or update backend feature documentation that follows a repo's DOCUMENTATION_GUIDELINES.md (or equivalent) across any project. Use when asked to create/update module docs, API contracts, or backend documentation that must include architecture, endpoints, payloads, Mermaid diagrams, and seeding instructions.

documentation-generation-doc-generate

16
from diegosouzapw/awesome-omni-skill

You are a documentation expert specializing in creating comprehensive, maintainable documentation from code. Generate API docs, architecture diagrams, user guides, and technical references using AI...

create-oo-component-documentation

16
from diegosouzapw/awesome-omni-skill

Create comprehensive, standardized documentation for object-oriented components following industry best practices and architectural documentation standards.