FAQ Generator
Creates FAQ lists from medical documents.
Features
- Automatic Q&A generation
- Policy interpretation
- Patient-friendly language
- Structured formatting
Parameters
| Parameter | Type | Default | Required | Description |
|---|---|---|---|---|
--input, -i |
string | - | Yes | Source document file path |
--audience, -a |
string | general | No | Target audience (patients, researchers, general) |
--output, -o |
string | stdout | No | Output file path |
--format, -f |
string | json | No | Output format (json, markdown, text) |
Output Format
{
"faqs": [{"question": "", "answer": ""}],
"topic": "string"
}
Risk Assessment
| Risk Indicator | Assessment | Level |
|---|---|---|
| Code Execution | No scripts included | Low |
| Network Access | No external API calls | Low |
| File System Access | Read-only within workspace | Low |
| Instruction Tampering | Standard prompt guidelines | Low |
| Data Exposure | Input/output within session | Low |
Security Checklist
- No hardcoded credentials or API keys
- No unauthorized file system access (../)
- No network requests to external services
- Output does not expose sensitive information
- Prompt injection protections in place
Evaluation Criteria
Success Metrics
- FAQ accurately represents source document content
- Language is appropriate for specified audience (patients/researchers)
- Questions cover key points of the document
- Answers are clear, concise, and medically accurate
- Format follows structured JSON schema
Test Cases
- Basic FAQ Generation: Input simple medical protocol → Output valid FAQ list
- Audience Adaptation: Same input with different audiences → Appropriate tone shift
- Complex Document: Input lengthy policy document → Comprehensive FAQ coverage
- Edge Case: Input ambiguous content → Handles gracefully with clarifying questions
Lifecycle Status
- Current Stage: Draft
- Next Review Date: 2026-03-06
- Known Issues: None
- Planned Improvements:
- Add support for multi-language output
- Enhance medical terminology handling