ReddRadar
Agent skill
pact-prepare-research
Research methodologies and documentation gathering workflows for PACT Prepare phase. Use when: conducting technology research, evaluating API documentation, comparing framework options, analyzing library choices, gathering requirements, or creating technology comparison matrices. Triggers on: research, requirements gathering, API exploration, documentation review, technology evaluation, library comparison, prepare phase.
Install this agent skill to your Project
npx add-skill https://github.com/Synaptic-Labs-AI/PACT-Plugin/tree/main/pact-plugin/skills/pact-prepare-research
SKILL.md
PACT Prepare Research Methodology
Structured approaches for the Prepare phase of PACT. This skill provides frameworks for systematic research, documentation gathering, and technology evaluation to build a solid foundation before architecture and implementation.
Research Workflow
Phase 1: Define Research Scope
Before starting research, clearly define:
## Research Scope Definition
### Primary Question
What specific problem are we trying to solve?
### Success Criteria
What would make a solution acceptable?
- [ ] Performance requirements
- [ ] Integration requirements
- [ ] Security requirements
- [ ] Budget constraints
### Constraints
What limitations must we work within?
- Technology stack restrictions
- Team expertise
- Timeline
- Licensing requirements
Phase 2: Source Prioritization
Prioritize sources by authority and reliability:
| Priority | Source Type | Examples | Trust Level |
|---|---|---|---|
| 1 | Official documentation | Docs, API references | Highest |
| 2 | Official repositories | GitHub READMEs, wikis | Very High |
| 3 | Maintainer content | Blog posts by core team | High |
| 4 | Community verified | Stack Overflow accepted answers | Medium |
| 5 | Third-party tutorials | Blog posts, videos | Low-Medium |
| 6 | AI-generated content | ChatGPT, Copilot | Verify Required |
Source Verification Checklist:
- Publication date within 12 months (for version-specific info)
- Author has verifiable credentials
- Information matches official docs
- Code examples actually work
Phase 3: Documentation Types to Gather
Collect these documentation types for complete understanding:
1. API References
## API Documentation Checklist
- [ ] Authentication methods
- [ ] Rate limits and quotas
- [ ] Available endpoints
- [ ] Request/response formats
- [ ] Error codes and handling
- [ ] SDK availability
- [ ] Webhook support
2. Configuration Guides
## Configuration Documentation
- [ ] Environment variables
- [ ] Configuration file formats
- [ ] Default values
- [ ] Required vs optional settings
- [ ] Security-sensitive configs
3. Migration Documentation
## Migration Considerations
- [ ] Breaking changes between versions
- [ ] Deprecation timelines
- [ ] Migration guides
- [ ] Data migration requirements
4. Security Advisories
## Security Documentation
- [ ] Known vulnerabilities (CVEs)
- [ ] Security best practices
- [ ] Authentication requirements
- [ ] Data handling guidelines
Phase 4: Evaluation Criteria
Use this framework to evaluate research findings:
| Criterion | Questions | Weight |
|---|---|---|
| Currency | Updated within 12 months? Active development? | High |
| Authority | Official source? Maintainer authored? | High |
| Completeness | Covers required use cases? | Medium |
| Practicality | Actionable? Working examples? | Medium |
| Compatibility | Works with existing stack? | High |
| Community | Active community? Good support? | Medium |
| Security | Security track record? Quick patches? | High |
Quick Reference Templates
Technology Comparison
For structured side-by-side comparisons: See technology-comparison-matrix.md
Quick Comparison Template:
| Criterion | Option A | Option B | Winner |
|-----------|----------|----------|--------|
| Learning curve | Steep | Gentle | B |
| Performance | Fast | Very Fast | B |
| Documentation | Good | Excellent | B |
| Community size | Large | Medium | A |
| **Total** | 1 | 3 | **B** |
API Documentation Summary
For capturing API details systematically: See api-exploration-template.md
Quick API Summary:
## API: [Name]
**Base URL**: `https://api.example.com/v1`
**Auth**: Bearer token in header
**Rate Limit**: 100 req/min
### Key Endpoints
| Endpoint | Method | Purpose |
|----------|--------|---------|
| /users | GET | List users |
| /users/:id | GET | Get user |
| /users | POST | Create user |
### Authentication
```bash
curl -H "Authorization: Bearer YOUR_TOKEN" \
https://api.example.com/v1/users
### Requirements Analysis
For comprehensive requirements documentation:
See [requirements-analysis.md](references/requirements-analysis.md)
**Quick Requirements Template:**
```markdown
## Feature: [Name]
### User Story
As a [user type], I want [action] so that [benefit].
### Acceptance Criteria
- [ ] Given [context], when [action], then [result]
- [ ] Given [context], when [action], then [result]
### Technical Requirements
- Performance: [target]
- Security: [requirements]
- Integration: [dependencies]
### Dependencies
- Depends on: [other features/services]
- Blocked by: [blockers]
Research Output Format
Standard Research Document Structure
# Research: [Topic]
## Executive Summary
[2-3 sentence summary of findings and recommendation]
## Background
[Why this research was needed]
## Methodology
[How research was conducted]
## Findings
### Option 1: [Name]
**Pros:**
- [Pro 1]
- [Pro 2]
**Cons:**
- [Con 1]
- [Con 2]
**Evidence:**
- [Link to source]
- [Link to source]
### Option 2: [Name]
[Same structure]
## Comparison Matrix
[Side-by-side comparison table]
## Risk Assessment
| Risk | Probability | Impact | Mitigation |
|------|-------------|--------|------------|
| [Risk] | High/Med/Low | High/Med/Low | [Strategy] |
## Recommendation
[Clear recommendation with rationale]
## Next Steps
1. [Action item]
2. [Action item]
## References
- [Source 1]
- [Source 2]
Quality Checklist
Before completing Prepare phase research:
Source Quality
- All critical information from official sources
- Version numbers explicitly stated
- Publication dates verified (within 12 months for technical details)
- No single point of information failure (multiple sources for key facts)
Completeness
- All evaluation criteria addressed
- Alternatives presented with pros/cons
- Security implications documented
- Performance characteristics noted
- Integration requirements identified
Actionability
- Recommendations backed by evidence
- Next steps clearly defined
- Risks identified with mitigations
- Dependencies mapped
Documentation
- Research document follows standard structure
- All sources linked and accessible
- Key decisions documented with rationale
- Output saved to
docs/{feature}/preparation/
Common Research Patterns
Library/Framework Selection
- Define requirements and constraints
- Identify 3-5 candidates
- Evaluate against criteria matrix
- Prototype with top 2 candidates
- Document decision rationale
API Integration Research
- Gather official API documentation
- Test authentication flow
- Document all required endpoints
- Identify rate limits and quotas
- Plan error handling strategy
Technology Migration
- Document current state
- Research target technology
- Identify breaking changes
- Plan migration path
- Define rollback strategy
Detailed References
For comprehensive templates and frameworks:
-
API Exploration Template: references/api-exploration-template.md
- Full API documentation template
- Authentication testing guide
- Error handling documentation
-
Requirements Analysis Framework: references/requirements-analysis.md
- User story templates
- Acceptance criteria patterns
- Non-functional requirements
-
Technology Comparison Matrix: references/technology-comparison-matrix.md
- Weighted scoring templates
- Multi-criteria decision analysis
- Risk assessment frameworks
Recommended Agent Skills
Expand your agent's capabilities with these related and highly-rated skills.
Synaptic-Labs-AI/PACT-Plugin
n8n-code-javascript
Write JavaScript code in n8n Code nodes. Use when writing JavaScript in n8n, using $input/$json/$node syntax, making HTTP requests with $helpers, working with dates using DateTime, troubleshooting Code node errors, or choosing between Code node modes.
Synaptic-Labs-AI/PACT-Plugin
n8n-node-configuration
Operation-aware node configuration guidance. Use when configuring nodes, understanding property dependencies, determining required fields, choosing between get_node detail levels, or learning common configuration patterns by node type.
Synaptic-Labs-AI/PACT-Plugin
pact-coding-standards
Clean code principles, error handling patterns, and coding standards for PACT Code phase. Use when: implementing features, refactoring code, reviewing code quality, establishing coding conventions, or handling errors and exceptions. Triggers on: code quality, clean code, refactoring, error handling, logging patterns, naming conventions, code review, code phase.
Synaptic-Labs-AI/PACT-Plugin
pact-handoff-harvest
HANDOFF discovery, review, save, and cleanup workflow for the PACT secretary. Use when: processing agent HANDOFFs after workflow phases, running session consolidation, or recovering orphaned breadcrumbs from prior sessions. Triggers: harvest HANDOFFs, process HANDOFFs, incremental, consolidation, breadcrumb recovery.
Synaptic-Labs-AI/PACT-Plugin
n8n-code-python
Write Python code in n8n Code nodes. Use when writing Python in n8n, using _input/_json/_node syntax, working with standard library, or need to understand Python limitations in n8n Code nodes.
Synaptic-Labs-AI/PACT-Plugin
n8n-workflow-patterns
Proven workflow architectural patterns from real n8n workflows. Use when building new workflows, designing workflow structure, choosing workflow patterns, planning workflow architecture, or asking about webhook processing, HTTP API integration, database operations, AI agent workflows, or scheduled tasks.
Didn't find tool you were looking for?