Overview
DecipherIt automatically generates 10 frequently asked questions with detailed, well-cited answers from your research. FAQs are created by the same CrewAI research agents that analyze your content, ensuring accuracy and relevance.FAQs are generated automatically during the research processing workflow - no additional action required.
How It Works
Research Context
The FAQ generation task uses the research analysis as context.Context Dependency:
- Executes after research analysis completes
- Has access to all research findings
- Understands key themes and patterns
- Knows which topics are most important
backend/agents/topic_research_agent.py:154-161Question Generation
The Researcher agent identifies 10 relevant questions readers might ask.Question Criteria:
- Covers different aspects/themes from research
- Progresses from basic to advanced topics
- Focuses on likely reader questions
- Clear and specific wording
- Unique and non-repetitive
backend/config/topic_research/tasks.py:170-206Answer Creation
Detailed answers are written based on research findings.Answer Requirements:
- Accurate information from research
- Citations from sources
- Markdown formatting
- Concise but comprehensive
- Professional and accessible tone
- Relevant quotes when helpful
backend/config/topic_research/tasks.py:188-205FAQ Structure
- Question Format
- Answer Format
Questions are crafted to be:Clear and Specific:
- “What are the main benefits of microservices architecture?”
- “How does climate change affect marine ecosystems?”
- “What evidence supports the effectiveness of remote work?”
- Vague: “What is microservices?”
- Too broad: “Tell me about climate?”
- Yes/no: “Is remote work good?”
Accessing FAQs
UI Implementation:
client/components/notebook/notebook-polling.tsx:179-209
Technical Implementation
FAQ Task Configuration
backend/config/topic_research/tasks.py:170-206
Output Data Model
backend/models/topic_research_models.py
Crew Integration
backend/agents/topic_research_agent.py:164-259
FAQ Display Component
client/components/notebook/notebook-polling.tsx:179-209
Quality Features
Research-Grounded
All answers strictly based on your research sources with verifiable citations.
Progressive Depth
Questions organized from fundamental to advanced for natural learning flow.
Rich Formatting
Markdown rendering supports bold, italic, lists, quotes, and links for readability.
Source Transparency
Every claim cited with clickable links to original sources.
Use Cases
Quick Reference
Quick Reference
Use FAQs for:
- Quick answers without reading full summary
- Pre-meeting preparation
- Overview of key points
- Refresher on research findings
Learning and Education
Learning and Education
FAQs help with:
- Understanding complex topics progressively
- Identifying knowledge gaps
- Structured learning path
- Self-assessment questions
Content Creation
Content Creation
Use FAQs to:
- Identify common questions for blog posts
- Structure presentations
- Create talking points
- Develop educational materials
Research Validation
Research Validation
FAQs can:
- Highlight areas needing deeper research
- Reveal perspective gaps
- Identify contradictions
- Suggest follow-up questions
Example FAQ Output
- Topic Research
- Source Research
Topic: “Impact of AI on software development”Sample Questions:
- What are the primary ways AI is transforming software development?
- How do AI code assistants improve developer productivity?
- What are the limitations of current AI coding tools?
- How is AI affecting software testing practices?
- What skills should developers focus on in the AI era?
- Are there security concerns with AI-generated code?
- How do different AI models compare for coding tasks?
- What does research say about AI replacing developers?
- How are companies integrating AI into development workflows?
- What future developments in AI for coding are predicted?
Markdown Rendering
FAQ answers support full markdown:Text Formatting
Bold, italic,
code, and regular text mixingLists
Bullet points and numbered lists for organized information
Quotes
Block quotes for citations and emphasis
Links
Clickable source citations and references
Headings
Subheadings for structured answers
Code Blocks
Syntax highlighting for technical content
Performance Optimizations
Memoized Components
FAQ list component is memoized to prevent unnecessary re-renders.
Parallel Generation
FAQ task runs in parallel with content creation for faster processing.
Structured Output
Pydantic models ensure type-safe, validated output without manual parsing.
Context Reuse
Shares research analysis context, avoiding redundant LLM calls.
Best Practices
Limitations
Comparison with Interactive Q&A
| Feature | FAQs | Interactive Q&A |
|---|---|---|
| Generation | Automatic | On-demand |
| Questions | Pre-generated (10) | Unlimited custom |
| Context | Full research | Last 10 messages |
| Speed | Instant (pre-made) | ~5-10 seconds |
| Citations | Built-in | Included |
| Use Case | Quick reference | Specific queries |
Related Features
Interactive Q&A
Ask custom questions about your research
AI Summaries
Read comprehensive research summary
Audio Overviews
Listen to podcast-style summary